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

Interface	osid.inventory.shipment.ShipmentQuerySession
Implements	`osid.OsidSession`
Implemented By	`osid.inventory.shipment.ShipmentSearchSession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session provides methods for searching among `Shipments`. The search query is constructed using the `ShipmentQuery`. This session defines views that offer differing behaviors for searching. federated warehouse view: searches include shipments in warehouses of which this warehouse is an ancestor in the warehouse hierarchy isolated warehouse view: searches are restricted to shipments in this warehouse Shipments may have a query record indicated by their respective record types. The query record is accessed via the `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	canSearchShipments
Description	Tests if this user can perform `Shipment` searches. 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 opt not to offer search 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 shipments 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	getShipmentQuery
Description	Gets a shipment query.
Return	`osid.inventory.shipment.ShipmentQuery`		the shipment query
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentsByQuery
Description	Gets a list of `Shipments` matching the given shipment query.
Parameters	`osid.inventory.shipment.ShipmentQuery`	`shipmentQuery`	the shipment query
Return	`osid.inventory.shipment.ShipmentList`		the returned `ShipmentList`
Errors	NULL_ARGUMENT		`shipmentQuery` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`shipmentQuery` is not of this service
Compliance	`mandatory`		This method must be implemented.