OSID - osid.inventory.InventorySmartWarehouseSession Service Interface Definition

Interface	osid.inventory.InventorySmartWarehouseSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.InventoryManager`
Used By	`osid.inventory.InventoryProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. An `InventoryQuery` can be retrieved from this session and mapped to this `Warehouse` to create a virtual collection of `Inventories`. The inventories may be sequenced using the `InventorySearchOrder` from this session. This `Warehouse` has a default query that matches any inventory and a default search order that specifies no sequencing. The queries may be examined using an `InventoryQueryInspector`. The query may be modified by converting the inspector back to an `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	canManageSmartWarehouses
Description	Tests if this user can manage smart warehouses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.
Return	`boolean`		`false` if smart warehouse management is not authorized, `true` otherwise
Compliance	`mandatory`		This method 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	getInventorySearchOrder
Description	Gets an inventory search order.
Return	`osid.inventory.InventorySearchOrder`		the inventory search order
Compliance	`mandatory`		This method must be implemented.
Method	applyInventoryQuery
Description	Applies an inventory query to this warehouse.
Parameters	`osid.inventory.InventoryQuery`	`inventoryQuery`	the inventory query
Errors	NULL_ARGUMENT		`inventoryQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inventoryQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectInventoryQuery
Description	Gets an inventory query inspector for this warehouse.
Return	`osid.inventory.InventoryQueryInspector`		the inventory query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyInventorySequencing
Description	Applies an inventory search order to this warehouse.
Parameters	`osid.inventory.InventorySearchOrder`	`inventorySearchOrder`	the inventory search order
Errors	NULL_ARGUMENT		`inventorySearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`inventorySearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getInventoryQueryFromInspector
Description	Gets an inventory query from an inspector.
Parameters	`osid.inventory.InventoryQueryInspector`	`inventoryQueryInspector`	a query inspector
Return	`osid.inventory.InventoryQuery`		the inventory query
Errors	NULL_ARGUMENT		`inventoryQueryInspector` is `null`
Errors	UNSUPPORTED		`inventoryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.