public interface ItemQuery extends OsidObjectQuery
This is the query for searching items. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearItemIdTerms()
Clears the item
Id terms. |
void |
clearItemTerms()
Clears the item terms.
|
void |
clearLocationDescriptionTerms()
Clears the location description terms.
|
void |
clearLocationIdTerms()
Clears the location
Id terms. |
void |
clearLocationTerms()
Clears the location terms.
|
void |
clearPropertyTagTerms()
Clears the property tag terms.
|
void |
clearSerialNumberTerms()
Clears the serial number terms.
|
void |
clearStockIdTerms()
Clears the stock
Id terms. |
void |
clearStockTerms()
Clears the stock terms.
|
void |
clearWarehouseIdTerms()
Clears the warehouse
Id terms. |
void |
clearWarehouseTerms()
Clears the warehouse terms.
|
ItemQuery |
getItemQuery()
Gets the query for an item.
|
ItemQueryRecord |
getItemQueryRecord(Type itemRecordType)
Gets the item query record corresponding to the given
Item
record Type. |
LocationQuery |
getLocationQuery()
Gets the query for a location.
|
StockQuery |
getStockQuery()
Gets the query for a stocjk.
|
WarehouseQuery |
getWarehouseQuery()
Gets the query for a warehouse.
|
void |
matchAnyItem(boolean match)
Matches items that have any item.
|
void |
matchAnyLocation(boolean match)
Matches items that have any location.
|
void |
matchAnyLocationDescription(boolean match)
Matches items that have any location description.
|
void |
matchAnyPropertyTag(boolean match)
Matches items that have any property tag.
|
void |
matchAnySerialNumber(boolean match)
Matches items that have any serial number.
|
void |
matchAnyStock(boolean match)
Matches items that have any stock.
|
void |
matchItemId(Id itemId,
boolean match)
Sets the item
Id for this query to match items part of
the given item. |
void |
matchLocationDescription(java.lang.String location,
Type stringMatchType,
boolean match)
Matches a location description.
|
void |
matchLocationId(Id locationId,
boolean match)
Sets the location
Id for this query. |
void |
matchPropertyTag(java.lang.String property,
Type stringMatchType,
boolean match)
Matches a property identification number.
|
void |
matchSerialNumber(java.lang.String serial,
Type stringMatchType,
boolean match)
Matches a serial number.
|
void |
matchStockId(Id stockId,
boolean match)
Sets the stock
Id for this query. |
void |
matchWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match items
assigned to warehouses. |
boolean |
supportsItemQuery()
Tests if an
ItemQuery is available. |
boolean |
supportsLocationQuery()
Tests if a
LocationQuery is available. |
boolean |
supportsStockQuery()
Tests if a
StockQuery is available. |
boolean |
supportsWarehouseQuery()
Tests if a
WarehouseQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchStockId(Id stockId, boolean match)
Id
for this query.stockId
- the stock Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearStockIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsStockQuery()
StockQuery
is available. true
if a stock query is available,
false
otherwisemandatory
- This method must be implemented. StockQuery getStockQuery()
OR
term.UnimplementedException
- supportsStockQuery()
is false
optional
- This method must be implemented if
supportsStockQuery()
is true.
void matchAnyStock(boolean match)
match
- true
to match items with any stock,
false
to match items with no stockmandatory
- This method must be implemented. void clearStockTerms()
mandatory
- This method must be implemented. void matchPropertyTag(java.lang.String property, Type stringMatchType, boolean match)
property
- a property numberstringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- property
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyPropertyTag(boolean match)
match
- true
to match items with any property
tag, false
to match items with no property tagmandatory
- This method must be implemented. void clearPropertyTagTerms()
mandatory
- This method must be implemented. void matchSerialNumber(java.lang.String serial, Type stringMatchType, boolean match)
serial
- a serial numberstringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- serial
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySerialNumber(boolean match)
match
- true
to match items with any serial
number, false
to match items with no serial
numbermandatory
- This method must be implemented. void clearSerialNumberTerms()
mandatory
- This method must be implemented. void matchLocationDescription(java.lang.String location, Type stringMatchType, boolean match)
location
- a location stringstringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- location
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyLocationDescription(boolean match)
match
- true
to match items with any location
string, false
to match items with no location
stringmandatory
- This method must be implemented. void clearLocationDescriptionTerms()
mandatory
- This method must be implemented. void matchLocationId(Id locationId, boolean match)
Id
for this query.locationId
- the location Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocationIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLocationQuery()
LocationQuery
is available. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getLocationQuery()
OR
term.UnimplementedException
- supportsLocationQuery()
is false
optional
- This method must be implemented if
supportsLocationQuery()
is true.
void matchAnyLocation(boolean match)
match
- true
to match items with any location,
false
to match items with no locationmandatory
- This method must be implemented. void clearLocationTerms()
mandatory
- This method must be implemented. void matchItemId(Id itemId, boolean match)
Id
for this query to match items part of
the given item.itemId
- the item Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearItemIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsItemQuery()
ItemQuery
is available. true
if a item query is available, false
otherwisemandatory
- This method must be implemented. ItemQuery getItemQuery()
OR
term.UnimplementedException
- supportsItemQuery()
is false
optional
- This method must be implemented if
supportsItemQuery()
is true.
void matchAnyItem(boolean match)
match
- true
to match items part of any item,
false
to match items psrt of no itemmandatory
- This method must be implemented. void clearItemTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match items
assigned to warehouses.warehouseId
- the warehouse Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. void clearWarehouseIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsWarehouseQuery()
WarehouseQuery
is available. true
if a warehouse query is available,
false
otherwisemandatory
- This method must be implemented. WarehouseQuery getWarehouseQuery()
OR
term.UnimplementedException
-
supportsWarehouseQuery()
is false
optional
- This method must be implemented if
supportsWarehouseQuery()
is true.
void clearWarehouseTerms()
mandatory
- This method must be implemented. ItemQueryRecord getItemQueryRecord(Type itemRecordType) throws OperationFailedException
Item
record Type.
Multiple record retrievals produce
a nested OR
term.itemRecordType
- an item record typeNullArgumentException
- itemRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(itemRecordType)
is false
mandatory
- This method must be implemented.