OSID - osid.inventory.InventorySearchSession Service Interface Definition

Interface	osid.inventory.InventorySearchSession
Implements	`osid.inventory.InventoryQuerySession`
Description	This session provides methods for searching among `Inventory` objects. The search query is constructed using the `InventoryQuery.` `getInventoriesByQuery()` is the basic search method and returns a list of `Inventorys.` A more advanced search may be performed with `getInventorysBySearch().` It accepts an `InventorySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getInventoriesBySearch()` returns an `InventorySearchResults` that can be used to access the resulting `InventoryList` or be used to perform a search within the result set through `InventorySearch.` This session defines views that offer differing behaviors for searching. federated warehouse view: searches include inventories in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to inventories in this warehouse Inventories may have a query record indicated by their respective record types. The query record is accessed via the `InventoryQuery.`
Method	getInventorySearch
Description	Gets an inventory search.
Return	`osid.inventory.InventorySearch`		the inventory search
Compliance	`mandatory`		This method must be implemented.
Method	getInventorySearchOrder
Description	Gets an inventory search order. The `InventorySearchOrder` is supplied to an `InventorySearch` to specify the ordering of results.
Return	`osid.inventory.InventorySearchOrder`		the inventory search order
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.InventoryQuery`	`inventoryQuery`	the inventory query
Parameters	`osid.inventory.InventorySearch`	`inventorySearch`	the inventory search
Return	`osid.inventory.InventorySearchResults`		the inventory search results
Errors	NULL_ARGUMENT		`inventoryQuery` or `inventorySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inventoryQuery` or `inventorySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryQueryFromInspector
Description	Gets an inventory query from an inspector. The inspector is available from an `InventorySearchResults.`
Parameters	`osid.inventory.InventoryQueryInspector`	`inventoryQueryInspector`	an inventory query inspector
Return	`osid.inventory.InventoryQuery`		the inventory query
Errors	NULL_ARGUMENT		`inventoryQueryInspector` is `null`
Errors	UNSUPPORTED		`inventoryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.