OSID - osid.inventory.WarehouseQueryInspector Service Interface Definition

Interface	osid.inventory.WarehouseQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.inventory.InventoryQueryInspector`
	`osid.inventory.ItemQueryInspector`
	`osid.inventory.ModelQueryInspector`
	`osid.inventory.StockQueryInspector`
	`osid.inventory.WarehouseQueryInspector`
	`osid.inventory.WarehouseSearchResults`
	`osid.inventory.shipment.EntryQueryInspector`
	`osid.inventory.shipment.ShipmentQueryInspector`
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	getItemIdTerms
Description	Gets the item `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the item `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getItemTerms
Description	Gets the item query terms.
Return	`osid.inventory.ItemQueryInspector[]`		the item query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStockIdTerms
Description	Gets the stock `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the stock `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getStockTerms
Description	Gets the stock query terms.
Return	`osid.inventory.StockQueryInspector[]`		the stock 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	getInventoryIdTerms
Description	Gets the inventory `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the inventory `Id` query terms
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryTerms
Description	Gets the inventory query terms.
Return	`osid.inventory.InventoryQueryInspector[]`		the inventory query terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorWarehouseIdTerms
Description	Gets the ancestor warehouse `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the ancestor warehouse `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorWarehouseTerms
Description	Gets the ancestor warehouse query terms.
Return	`osid.inventory.WarehouseQueryInspector[]`		the ancestor warehouse terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantWarehouseIdTerms
Description	Gets the descendant warehouse `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the descendant warehouse `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantWarehouseTerms
Description	Gets the descendant warehouse query terms.
Return	`osid.inventory.WarehouseQueryInspector[]`		the descendant warehouse terms
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseQueryInspectorRecord
Description	Gets the warehouse query inspector record corresponding to the given `Warehouse` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`warehouseRecordType`	a warehouse record type
Return	`osid.inventory.records.WarehouseQueryInspectorRecord`		the warehouse query inspector record
Errors	NULL_ARGUMENT		`warehouseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(warehouseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.