public interface StockQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector
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 |
---|---|
IdTerm[] |
getAncestorStockIdTerms()
Gets the ancestor stock
Id query terms. |
StockQueryInspector[] |
getAncestorStockTerms()
Gets the ancestor stock query terms.
|
IdTerm[] |
getDescendantStockIdTerms()
Gets the descendant stock
Id query terms. |
StockQueryInspector[] |
getDescendantStockTerms()
Gets the descendant stock query terms.
|
StringTerm[] |
getLocationDescriptionTerms()
Gets the location description query terms.
|
IdTerm[] |
getLocationIdTerms()
Gets the location
Id query terms. |
LocationQueryInspector[] |
getLocationTerms()
Gets the location query terms.
|
IdTerm[] |
getModelIdTerms()
Gets the model
Id query terms. |
ModelQueryInspector[] |
getModelTerms()
Gets the model query terms.
|
StringTerm[] |
getSKUTerms()
Gets the SKU query terms.
|
StockQueryInspectorRecord |
getStockQueryInspectorRecord(Type stockRecordType)
Gets the stock query inspector record corresponding to the given
Stock record Type. |
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
StringTerm[] getSKUTerms()
mandatory
- This method must be implemented. IdTerm[] getModelIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. ModelQueryInspector[] getModelTerms()
mandatory
- This method must be implemented. StringTerm[] getLocationDescriptionTerms()
mandatory
- This method must be implemented. IdTerm[] getLocationIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. LocationQueryInspector[] getLocationTerms()
mandatory
- This method must be implemented. IdTerm[] getAncestorStockIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. StockQueryInspector[] getAncestorStockTerms()
mandatory
- This method must be implemented. IdTerm[] getDescendantStockIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. StockQueryInspector[] getDescendantStockTerms()
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. StockQueryInspectorRecord getStockQueryInspectorRecord(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.