OSID - osid.inventory.shipment.ShipmentSmartWarehouseSession Service Interface Definition

Interface	osid.inventory.shipment.ShipmentSmartWarehouseSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session manages queries and sequencing to create "smart" dynamic catalogs. A `ShipmentQuery` can be retrieved from this session and mapped to this `Warehouse` to create a virtual collection of `Shipments`. The shipments may be sequenced using the `ShipmentSearchOrder` from this session. This `Warehouse` has a default query that matches any shipment and a default search order that specifies no sequencing. The queries may be examined using a `ShipmentQueryInspector`. The query may be modified by converting the inspector back to a `ShipmentQuery`.
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	getShipmentQuery
Description	Gets a shipment query.
Return	`osid.inventory.shipment.ShipmentQuery`		the shipment query
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentSearchOrder
Description	Gets a shipment search order.
Return	`osid.inventory.shipment.ShipmentSearchOrder`		the shipment search order
Compliance	`mandatory`		This method must be implemented.
Method	applyShipmentQuery
Description	Applies a shipment query to this warehouse.
Parameters	`osid.inventory.shipment.ShipmentQuery`	`shipmentQuery`	the shipment query
Errors	NULL_ARGUMENT		`shipmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`shipmentQuery` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	inspectShipmentQuery
Description	Gets a shipment query inspector for this warehouse.
Return	`osid.inventory.shipment.ShipmentQueryInspector`		the shipment query inspector
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	applyShipmentSequencing
Description	Applies a shipment search order to this warehouse.
Parameters	`osid.inventory.shipment.ShipmentSearchOrder`	`shipmentSearchOrder`	the shipment search order
Errors	NULL_ARGUMENT		`shipmentSearchOrder` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`shipmentSearchOrder` not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentQueryFromInspector
Description	Gets a shipment query from an inspector.
Parameters	`osid.inventory.shipment.ShipmentQueryInspector`	`shipmentQueryInspector`	a query inspector
Return	`osid.inventory.shipment.ShipmentQuery`		the shipment query
Errors	NULL_ARGUMENT		`shipmentQueryInspector` is `null`
Errors	UNSUPPORTED		`shipmentQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.