OSID - osid.inventory.StockQuerySession Service Interface Definition

Interface	osid.inventory.StockQuerySession
Implements	`osid.OsidSession`
Description	This session provides methods for searching among `Stock` objects. The search query is constructed using the `StockQuery.` This session defines views that offer differing behaviors for searching. federated warehouse view: searches include stocks in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to stocks in this warehouse Stocks may have a query record indicated by their respective query record types. The query record is accessed via the `StockQuery.`
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	canSearchStocks
Description	Tests if this user can perform `Stock` 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 stocks 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	getStockQuery
Description	Gets a stock query.
Return	`osid.inventory.StockQuery`		the stock query.
Compliance	`mandatory`		This method must be implemented.
Method	getStocksByQuery
Description	Gets a list of `Stocks` matching the given stock query.
Parameters	`osid.inventory.StockQuery`	`stockQuery`	the stock query
Return	`osid.inventory.StockList`		the returned `StockList`
Errors	NULL_ARGUMENT		`stockQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`stockQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.