public interface WarehouseQuery extends OsidCatalogQuery
This is the query for searching warehouses. 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 |
clearAncestorWarehouseIdTerms()
Clears the ancestor warehouse
Id query terms. |
void |
clearAncestorWarehouseTerms()
Clears the ancestor warehouse query terms.
|
void |
clearDescendantWarehouseIdTerms()
Clears the descendant warehouse
Id query terms. |
void |
clearDescendantWarehouseTerms()
Clears the descendant warehouse query terms.
|
void |
clearInventoryIdTerms()
Clears the inventory
Id query terms. |
void |
clearInventoryTerms()
Clears the inventory query terms.
|
void |
clearItemIdTerms()
Clears the item
Id query terms. |
void |
clearItemTerms()
Clears the item query terms.
|
void |
clearModelIdTerms()
Clears the model
Id query terms. |
void |
clearModelTerms()
Clears the model terms.
|
void |
clearStockIdTerms()
Clears the stock
Id query terms. |
void |
clearStockTerms()
Clears the stock query terms.
|
WarehouseQuery |
getAncestorWarehouseQuery()
Gets the query for a warehouse.
|
WarehouseQuery |
getDescendantWarehouseQuery()
Gets the query for a warehouse.
|
InventoryQuery |
getInventoryQuery()
Gets the query for an inventory.
|
ItemQuery |
getItemQuery()
Gets the query for an item.
|
ModelQuery |
getModelQuery()
Gets the query for an inventory.
|
StockQuery |
getStockQuery()
Gets the query for a stock.
|
WarehouseQueryRecord |
getWarehouseQueryRecord(Type warehouseRecordType)
Gets the warehouse query record corresponding to the given
Warehouse record Type. |
void |
matchAncestorWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match
warehouses that have the specified warehouse as an ancestor. |
void |
matchAnyAncestorWarehouse(boolean match)
Matches warehouses with any warehouse ancestor.
|
void |
matchAnyDescendantWarehouse(boolean match)
Matches warehouses with any descendant warehouse.
|
void |
matchAnyInventory(boolean match)
Matches warehouses that have any inventory.
|
void |
matchAnyItem(boolean match)
Matches warehouses that have any item.
|
void |
matchAnyModel(boolean match)
Matches any related model.
|
void |
matchAnyStock(boolean match)
Matches warehouses that have any stock.
|
void |
matchDescendantWarehouseId(Id warehouseId,
boolean match)
Sets the warehouse
Id for this query to match
warehouses that have the specified warehouse as an descendant. |
void |
matchInventoryId(Id itemId,
boolean match)
Sets the inventory
Id for this query. |
void |
matchItemId(Id itemId,
boolean match)
Sets the item
Id for this query. |
void |
matchModelId(Id modelId,
boolean match)
Sets the model
Id for this query. |
void |
matchStockId(Id stockId,
boolean match)
Sets the catalog
Id for this query. |
boolean |
supportsAncestorWarehouseQuery()
Tests if a
WarehouseQuery is available. |
boolean |
supportsDescendantWarehouseQuery()
Tests if a
WarehouseQuery is available. |
boolean |
supportsInventoryQuery()
Tests if an
InventoryQuery is available. |
boolean |
supportsItemQuery()
Tests if an
ItemQuery is available. |
boolean |
supportsModelQuery()
Tests if a
ModelQuery is available. |
boolean |
supportsStockQuery()
Tests if a
StockQuery 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchItemId(Id itemId, boolean match)
Id
for this query.itemId
- an item Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- itemId
is
null
mandatory
- This method must be implemented. void clearItemIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsItemQuery()
ItemQuery
is available. true
if an 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 warehouses with any item,
false
to match warehouses with no itemsmandatory
- This method must be implemented. void clearItemTerms()
mandatory
- This method must be implemented. void matchStockId(Id stockId, boolean match)
Id
for this query.stockId
- a stock Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- stockId
is
null
mandatory
- This method must be implemented. void clearStockIdTerms()
Id
query 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 courses with any stock,
false
to match courses with no stockmandatory
- This method must be implemented. void clearStockTerms()
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
query 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 warehouses with any model,
false
to match warehouses with no modelsmandatory
- This method must be implemented. void clearModelTerms()
mandatory
- This method must be implemented. void matchInventoryId(Id itemId, boolean match)
Id
for this query.itemId
- an inventory Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- inventoryId
is
null
mandatory
- This method must be implemented. void clearInventoryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsInventoryQuery()
InventoryQuery
is available. true
if an inventory query is available,
false
otherwisemandatory
- This method must be implemented. InventoryQuery getInventoryQuery()
OR
term.UnimplementedException
-
supportsInventoryQuery()
is false
optional
- This method must be implemented if
supportsInventoryQuery()
is true.
void matchAnyInventory(boolean match)
match
- true
to match warehouses with any
inventory, false
to match warehouses with no
inventoriesmandatory
- This method must be implemented. void clearInventoryTerms()
mandatory
- This method must be implemented. void matchAncestorWarehouseId(Id warehouseId, boolean match)
Id
for this query to match
warehouses that have the specified warehouse as an ancestor.warehouseId
- a warehouse Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. void clearAncestorWarehouseIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorWarehouseQuery()
WarehouseQuery
is available. true
if a warehouse query is available,
false
otherwisemandatory
- This method must be implemented. WarehouseQuery getAncestorWarehouseQuery()
OR
term.UnimplementedException
-
supportsAncestorWarehouseQuery()
is false
optional
- This method must be implemented if
supportsAncestorWarehouseQuery()
is true.
void matchAnyAncestorWarehouse(boolean match)
match
- true
to match warehouses with any
ancestor, false
to match root warehousesmandatory
- This method must be implemented. void clearAncestorWarehouseTerms()
mandatory
- This method must be implemented. void matchDescendantWarehouseId(Id warehouseId, boolean match)
Id
for this query to match
warehouses that have the specified warehouse as an descendant.warehouseId
- a warehouse Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- warehouseId
is
null
mandatory
- This method must be implemented. void clearDescendantWarehouseIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantWarehouseQuery()
WarehouseQuery
is available. true
if a warehouse query is available,
false
otherwisemandatory
- This method must be implemented. WarehouseQuery getDescendantWarehouseQuery()
OR
term.UnimplementedException
-
supportsDescendantWarehouseQuery()
is false
optional
- This method must be implemented if
supportsDescendantWarehouseQuery()
is true.
void matchAnyDescendantWarehouse(boolean match)
match
- true
to match warehouses with any
descendant, false
to match leaf warehousesmandatory
- This method must be implemented. void clearDescendantWarehouseTerms()
mandatory
- This method must be implemented. WarehouseQueryRecord getWarehouseQueryRecord(Type warehouseRecordType) throws OperationFailedException
Warehouse
record Type.
Multiple record
retrievals produce a nested OR
term.warehouseRecordType
- a warehouse record typeNullArgumentException
- warehouseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(warehouseRecordType)
is false
mandatory
- This method must be implemented.