OSID - osid.inventory.ItemSearchSession Service Interface Definition

Interface	osid.inventory.ItemSearchSession
Implements	`osid.inventory.ItemQuerySession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session provides methods for searching among `Items`. The search query is constructed using the `ItemQuery`. `getItemsByQuery()` is the basic search method and returns a list of `Items`. A more advanced search may be performed with `getItemsBySearch()`. It accepts an `ItemSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getItemsBySearch()` returns an `ItemSearchResults` that can be used to access the resulting `ItemList` or be used to perform a search within the result set through `ItemSearch`. This session defines views that offer differing behaviors for searching. federated warehouse view: searches include items in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to items in this warehouse Items may have a query record indicated by their respective record types. The query record is accessed via the `ItemQuery`.
Method	getItemSearch
Description	Gets an item search.
Return	`osid.inventory.ItemSearch`		the item search
Compliance	`mandatory`		This method must be implemented.
Method	getItemSearchOrder
Description	Gets an inventory search order. The `ItemSearchOrder` is supplied to an `ItemSearch` to specify the ordering of results.
Return	`osid.inventory.ItemSearchOrder`		the item search order
Compliance	`mandatory`		This method must be implemented.
Method	getItemsBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.ItemQuery`	`itemQuery`	the item query
Parameters	`osid.inventory.ItemSearch`	`itemSearch`	the item search
Return	`osid.inventory.ItemSearchResults`		the item search results
Errors	NULL_ARGUMENT		`itemQuery` or `itemSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`itemQuery` or `itemSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getItemQueryFromInspector
Description	Gets an item query from an inspector. The inspector is available from an `ItemSearchResults`.
Parameters	`osid.assessment.ItemQueryInspector`	`itemQueryInspector`	an item query inspector
Return	`osid.inventory.ItemQuery`		the item query
Errors	NULL_ARGUMENT		`itemQueryInspector` is `null`
Errors	UNSUPPORTED		`itemQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.