public interface StockQuery extends OsidObjectQuery, OsidFederateableQuery
This is the query for searching stocks. 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 |
clearAncestorStockIdTerms()
Clears the ancestor stock
Id query terms. |
void |
clearAncestorStockTerms()
Clears the ancestor stock query terms.
|
void |
clearDescendantStockIdTerms()
Clears the descendant stock
Id query terms. |
void |
clearDescendantStockTerms()
Clears the descendant stock query terms.
|
void |
clearLocationDescriptionTerms()
Clears the location description terms.
|
void |
clearLocationIdTerms()
Clears the location
Id terms. |
void |
clearLocationTerms()
Clears the location terms.
|
void |
clearModelIdTerms()
Clears the model
Id terms. |
void |
clearModelTerms()
Clears the model terms.
|
void |
clearSKUTerms()
Clears the sku terms.
|
void |
clearWarehouseIdTerms()
Clears the warehouse
Id query terms. |
void |
clearWarehouseTerms()
Clears the warehouse terms.
|
StockQuery |
getAncestorStockQuery()
Gets the query for a stock.
|
StockQuery |
getDescendantStockQuery()
Gets the query for a stock.
|
LocationQuery |
getLocationQuery()
Gets the query for a location.
|
ModelQuery |
getModelQuery()
Gets the query for an inventory.
|
StockQueryRecord |
getStockQueryRecord(Type stockRecordType)
Gets the stock query record corresponding to the given
Stock
record Type. |
WarehouseQuery |
getWarehouseQuery()
Gets the query for a warehouse.
|
void |
matchAncestorStockId(Id stockId,
boolean match)
Sets the stock
Id for this query to match stocks that
have the specified stock as an ancestor. |
void |
matchAnyAncestorStock(boolean match)
Matches stocks with any stock ancestor.
|
void |
matchAnyDescendantStock(boolean match)
Matches stocks with any descendant stock.
|
void |
matchAnyLocation(boolean match)
Matches items that have any location.
|
void |
matchAnyLocationDescription(boolean match)
Matches items that have any location description.
|
void |
matchAnyModel(boolean match)
Matches any related model.
|
void |
matchAnySKU(boolean match)
Matches items that have any sku.
|
void |
matchDescendantStockId(Id stockId,
boolean match)
Sets the stock
Id for this query to match stocks that
have the specified stock as an descendant. |
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 |
matchModelId(Id modelId,
boolean match)
Sets the model
Id for this query. |
void |
matchSKU(java.lang.String sku,
Type stringMatchType,
boolean match)
Matches a sku number.
|
void |
matchWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match stocks
assigned to warehouses. |
boolean |
supportsAncestorStockQuery()
Tests if a
StockQuery is available. |
boolean |
supportsDescendantStockQuery()
Tests if a
StockQuery is available. |
boolean |
supportsLocationQuery()
Tests if a
LocationQuery is available. |
boolean |
supportsModelQuery()
Tests if a
ModelQuery 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 matchSKU(java.lang.String sku, Type stringMatchType, boolean match)
sku
- a skustringMatchType
- a string match typematch
- true
if a positive match, false
for a negative matchNullArgumentException
- sku
or
stringMatchType
is null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnySKU(boolean match)
match
- true
to match items with any sku,
false
to match items with no skumandatory
- This method must be implemented. void clearSKUTerms()
mandatory
- This method must be implemented. void matchModelId(Id modelId, boolean match)
Id
for this query.modelId
- a model Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- modelId
is
null
mandatory
- This method must be implemented. void clearModelIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsModelQuery()
ModelQuery
is available. true
if a model query is available,
false
otherwisemandatory
- This method must be implemented. ModelQuery getModelQuery()
OR
term.UnimplementedException
- supportsModelQuery()
is false
optional
- This method must be implemented if
supportsModelQuery()
is true.
void matchAnyModel(boolean match)
match
- true
to match stocks with any model,
false
to match stocks with no modelsmandatory
- This method must be implemented. void clearModelTerms()
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 stocks with any location
string, false
to match stocks 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 stocks with any location,
false
to match stocks with no locationmandatory
- This method must be implemented. void clearLocationTerms()
mandatory
- This method must be implemented. void matchAncestorStockId(Id stockId, boolean match)
Id
for this query to match stocks that
have the specified stock as an ancestor.stockId
- a stock Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearAncestorStockIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorStockQuery()
StockQuery
is available. true
if a stock query is available,
false
otherwisemandatory
- This method must be implemented. StockQuery getAncestorStockQuery()
OR
term.UnimplementedException
-
supportsAncestorStockQuery()
is false
optional
- This method must be implemented if
supportsAncestorStockQuery()
is true.
void matchAnyAncestorStock(boolean match)
match
- true
to match stocks with any ancestor,
false
to match root stocksmandatory
- This method must be implemented. void clearAncestorStockTerms()
mandatory
- This method must be implemented. void matchDescendantStockId(Id stockId, boolean match)
Id
for this query to match stocks that
have the specified stock as an descendant.stockId
- a stock Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearDescendantStockIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantStockQuery()
StockQuery
is available. true
if a stock query is available,
false
otherwisemandatory
- This method must be implemented. StockQuery getDescendantStockQuery()
OR
term.UnimplementedException
-
supportsDescendantStockQuery()
is false
optional
- This method must be implemented if
supportsDescendantStockQuery()
is true.
void matchAnyDescendantStock(boolean match)
match
- true
to match stocks with any descendant,
false
to match leaf stocksmandatory
- This method must be implemented. void clearDescendantStockTerms()
mandatory
- This method must be implemented. void matchWarehouseId(Id warehouseId, boolean match)
Id
for this query to match stocks
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
query 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. StockQueryRecord getStockQueryRecord(Type stockRecordType) throws OperationFailedException
Stock
record Type.
Multiple record retrievals produce
a nested OR
term.stockRecordType
- a stock record typeNullArgumentException
- stockRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(stockRecordType)
is false
mandatory
- This method must be implemented.