public interface InventoryQueryInspector extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector
The query inspectors provide a means of accessing the match terms of a
query. These interfaces are used to examine the actual query terms used in
a search or that may be used to create a smart catalog. Query inspectors
may be converted to OsidQuery
interfaces for reuse or
modification in the search sessions.
Modifier and Type | Method and Description |
---|---|
DateTimeRangeTerm[] |
getDateInclusiveTerms()
Gets the date query terms.
|
DateTimeTerm[] |
getDateTerms()
Gets the date query terms.
|
InventoryQueryInspectorRecord |
getInventoryQueryInspectorRecord(Type inventoryRecordType)
Gets the inventory query inspector record corresponding to the given
Inventory record Type. |
DecimalRangeTerm[] |
getQuantityTerms()
Gets the quantity terms.
|
IdTerm[] |
getStockIdTerms()
Gets the stock
Id query terms. |
StockQueryInspector[] |
getStockTerms()
Gets the stock query terms.
|
IdTerm[] |
getWarehouseIdTerms()
Gets the warehouse
Id query terms. |
WarehouseQueryInspector[] |
getWarehouseTerms()
Gets the warehouse query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
IdTerm[] getStockIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. StockQueryInspector[] getStockTerms()
mandatory
- This method must be implemented. DateTimeTerm[] getDateTerms()
mandatory
- This method must be implemented. DateTimeRangeTerm[] getDateInclusiveTerms()
mandatory
- This method must be implemented. DecimalRangeTerm[] getQuantityTerms()
mandatory
- This method must be implemented. IdTerm[] getWarehouseIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. WarehouseQueryInspector[] getWarehouseTerms()
mandatory
- This method must be implemented. InventoryQueryInspectorRecord getInventoryQueryInspectorRecord(Type inventoryRecordType) throws OperationFailedException
Inventory
record Type.
Multiple record
retrievals produce a nested OR
term.inventoryRecordType
- an inventory record typeNullArgumentException
- inventoryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(inventoryRecordType)
is false
mandatory
- This method must be implemented.