OSID - osid.inventory.WarehouseQuerySession Service Interface Definition

Interface	osid.inventory.WarehouseQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.inventory.WarehouseSearchSession`
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`. 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	canSearchWarehouses
Description	Tests if this user can perform `Warehouse` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if search methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseQuery
Description	Gets a warehouse query.
Return	`osid.inventory.WarehouseQuery`		the warehouse query
Compliance	`mandatory`		This method must be implemented.
Method	getWarehousesByQuery
Description	Gets a list of `Warehouses` matching the given warehouse query.
Parameters	`osid.inventory.WarehouseQuery`	`warehouseQuery`	the warehouse query
Return	`osid.inventory.WarehouseList`		the returned `WarehouseList`
Errors	NULL_ARGUMENT		`warehouseQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`warehouseQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.