OSID - osid.inventory.StockQueryInspector Service Interface Definition

Interface	osid.inventory.StockQueryInspector
Implements	`osid.OsidObjectQueryInspector`
Implements	`osid.OsidFederateableQueryInspector`
Used By	`osid.checklist.mason.TodoProducerQueryInspector`
	`osid.inventory.InventoryQueryInspector`
	`osid.inventory.ItemQueryInspector`
	`osid.inventory.StockQueryInspector`
	`osid.inventory.StockSearchResults`
	`osid.inventory.StockSmartWarehouseSession`
	`osid.inventory.WarehouseQueryInspector`
	`osid.inventory.shipment.EntryQueryInspector`
	`osid.recipe.IngredientQueryInspector`
Description	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.
Method	getSKUTerms
Description	Gets the SKU query terms.
Return	`osid.search.terms.StringTerm[]`		the SKU query terms
Compliance	`mandatory`		This method must be implemented.
Method	getModelIdTerms
Description	Gets the model `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the model `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getModelTerms
Description	Gets the model query terms.
Return	`osid.inventory.ModelQueryInspector[]`		the model query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLocationDescriptionTerms
Description	Gets the location description query terms.
Return	`osid.search.terms.StringTerm[]`		the location description query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLocationIdTerms
Description	Gets the location `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the location `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getLocationTerms
Description	Gets the location query terms.
Return	`osid.mapping.LocationQueryInspector[]`		the location query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorStockIdTerms
Description	Gets the ancestor stock `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the ancestor stock `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorStockTerms
Description	Gets the ancestor stock query terms.
Return	`osid.inventory.StockQueryInspector[]`		the ancestor stock terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantStockIdTerms
Description	Gets the descendant stock `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the descendant stock `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantStockTerms
Description	Gets the descendant stock query terms.
Return	`osid.inventory.StockQueryInspector[]`		the descendant stock terms
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseIdTerms
Description	Gets the warehouse `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the warehouse `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseTerms
Description	Gets the warehouse query terms.
Return	`osid.inventory.WarehouseQueryInspector[]`		the warehouse query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStockQueryInspectorRecord
Description	Gets the stock query inspector record corresponding to the given `Stock` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`stockRecordType`	a stock record type
Return	`osid.inventory.records.StockQueryInspectorRecord`		the stock query inspector record
Errors	NULL_ARGUMENT		`stockRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(stockRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.