OSID - osid.inventory.WarehouseSearchSession Service Interface Definition

Interface	osid.inventory.WarehouseSearchSession
Implements	`osid.inventory.WarehouseQuerySession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session provides methods for searching among `Warehouses`. The search query is constructed using the `WarehouseQuery`. `getWarehousesByQuery()` is the basic search method and returns a list of `Warehouses`. A more advanced search may be performed with `getWarehousesBySearch()`.It accepts a `WarehouseSearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getWarehousesBySearch()` returns a `WarehouseSearchResults` that can be used to access the resulting `WarehouseList` or be used to perform a search within the result set through `Warehousesearch`. This session defines views that offer differing behaviors for searching. federated warehouse view: searches include warehouses in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to warehouses in this warehouse warehouses may have a query record indicated by their respective record types. The query record is accessed via the `WarehouseQuery`.
Method	getWarehouseSearch
Description	Gets a warehouse search.
Return	`osid.inventory.WarehouseSearch`		the warehouse search
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseSearchOrder
Description	Gets a warehouse search order. The `WarehouseSearchOrder` is supplied to a `WarehouseSearch` to specify the ordering of results.
Return	`osid.inventory.WarehouseSearchOrder`		the warehouse search order
Compliance	`mandatory`		This method must be implemented.
Method	getWarehousesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.inventory.WarehouseQuery`	`warehouseQuery`	the warehouse query
Parameters	`osid.inventory.WarehouseSearch`	`warehouseSearch`	the warehouse search
Return	`osid.inventory.WarehouseSearchResults`		the warehouse search results
Errors	NULL_ARGUMENT		`warehouseQuery` or `warehouseSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`warehouseQuery` or `warehouseSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseQueryFromInspector
Description	Gets a warehouse query from an inspector. The inspector is available from a `WarehousesearchResults`.
Parameters	`osid.inventory.WarehouseQueryInspector`	`warehouseQueryInspector`	a warehouse query inspector
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Errors	NULL_ARGUMENT		`warehouseQueryInspector` is `null`
Errors	UNSUPPORTED		`warehouseQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.