OSID - osid.inventory.InventoryQuerySession Service Interface Definition

Interface	osid.inventory.InventoryQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Inventory` objects. The search query is constructed using the `InventoryQuery.` 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	getWarehouseId
Description	Gets the `Warehouse` `Id` associated with this session.
Return	`osid.id.Id`		the `Warehouse Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouse
Description	Gets the `Warehouse` associated with this session.
Return	`osid.inventory.Warehouse`		the warehouse
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSearchInventories
Description	Tests if this user can perform `Inventory` 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	useFederatedWarehouseView
Description	Federates the view for methods in this session. A federated view will include inventories in warehouse which are children of this warehouse in the warehouse hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedWarehouseView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this warehouse only.
Compliance	`mandatory`		This method is must be implemented.
Method	getInventoryQuery
Description	Gets an inventory query.
Return	`osid.inventory.InventoryQuery`		the inventory query
Compliance	`mandatory`		This method must be implemented.
Method	getInventoriesByQuery
Description	Gets a list of `Inventories` matching the given inventory query.
Parameters	`osid.inventory.InventoryQuery`	`inventoryQuery`	the inventory query
Return	`osid.inventory.InventoryList`		the returned `InventoryList`
Errors	NULL_ARGUMENT		`inventoryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`inventoryQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.