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

Interface	osid.inventory.shipment.ShipmentWarehouseSession
Implements	`osid.OsidSession`
Used By	`osid.inventory.shipment.InventoryShipmentManager`
Used By	`osid.inventory.shipment.InventoryShipmentProxyManager`
Description	This session provides methods to retrieve `Shipment` to `Warehouse` mappings. A `Shipment` may appear in multiple `Warehouse` objects. Each catalog may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupShipmentWarehouseMappings
Description	Tests if this user can perform lookups of shipment/warehouse mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeShipmentWarehouseView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryShipmentWarehouseView
Description	A complete view of the `Shipment` and `Warehouse` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getShipmentIdsByWarehouse
Description	Gets the list of `Shipment Ids` associated with a `Warehouse`.
Parameters	`osid.id.Id`	`warehouseId`	`Id` of the `Warehouse`
Return	`osid.id.IdList`		list of related shipment `Ids`
Errors	NOT_FOUND		`warehouseId` is not found
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentsByWarehouse
Description	Gets the list of `Shipments` associated with a `Warehouse`.
Parameters	`osid.id.Id`	`warehouseId`	`Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentList`		list of related shipments
Errors	NOT_FOUND		`warehouseId` is not found
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentIdsByWarehouses
Description	Gets the list of `Shipment Ids` corresponding to a list of `Warehouse` objects.
Parameters	`osid.id.IdList`	`warehouseIds`	list of warehouse `Ids`
Return	`osid.id.IdList`		list of shipment `Ids`
Errors	NULL_ARGUMENT		`warehouseIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getShipmentsByWarehouses
Description	Gets the list of `Shipments` corresponding to a list of `Warehouse` objects.
Parameters	`osid.id.IdList`	`warehouseIds`	list of warehouse `Ids`
Return	`osid.inventory.shipment.ShipmentList`		list of shipments
Errors	NULL_ARGUMENT		`warehouseIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWarehouseIdsByShipment
Description	Gets the `Warehouse` `Ids` mapped to a `Shipment`.
Parameters	`osid.id.Id`	`shipmentId`	`Id` of a `Shipment`
Return	`osid.id.IdList`		list of warehouse `Ids`
Errors	NOT_FOUND		`shipmentId` is not found
	NULL_ARGUMENT		`shipmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getWarehousesByShipment
Description	Gets the `Warehouse` objects mapped to a `Shipment`.
Parameters	`osid.id.Id`	`shipmentId`	`Id` of a `Shipment`
Return	`osid.inventory.WarehouseList`		list of warehouses
Errors	NOT_FOUND		`shipmentId` is not found
	NULL_ARGUMENT		`shipmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.