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

Interface	osid.inventory.shipment.InventoryShipmentManager
Implements	`osid.OsidManager`
Implements	`osid.inventory.shipment.InventoryShipmentProfile`
Description	The inventory shipment manager provides access to shipment sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `ShipmentLookupSession:` a session to retrieve shipments `ShipmentQuerySession:` a session to query shipments `ShipmentSearchSession:` a session to search for shipments `ShipmentAdminSession:` a session to create and delete shipments `ShipmentNotificationSession:` a session to receive notifications pertaining to shipment changes `ShipmentWarehouseSession:` a session to look up shipment to warehouse mappings `ShipmentWarehouseAssignmentSession:` a session to manage shipment to warehouse mappings `ShipmentSmartWarehouseSession:` a session to manage dynamic warehouses of shipments
Method	getShipmentLookupSession
Description	Gets the `OsidSession` associated with the shipment lookup service.
Return	`osid.inventory.shipment.ShipmentLookupSession`		a `ShipmentLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentLookup()` is `true.`
Method	getShipmentLookupSessionForWarehouse
Description	Gets the `OsidSession` associated with the shipment lookup service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the warehouse
Return	`osid.inventory.shipment.ShipmentLookupSession`		a `ShipmentLookupSession`
Errors	NOT_FOUND		no `Warehouse` found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentLookup()` and `supportsVisibleFederation()` are `true`
Method	getShipmentQuerySession
Description	Gets the `OsidSession` associated with the shipment query service.
Return	`osid.inventory.shipment.ShipmentQuerySession`		a `ShipmentQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentQuery()` is `true.`
Method	getShipmentQuerySessionForWarehouse
Description	Gets the `OsidSession` associated with the shipment query service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentQuerySession`		a `ShipmentQuerySession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentQuery()` and `supportsVisibleFederation()` are `true`
Method	getShipmentSearchSession
Description	Gets the `OsidSession` associated with the shipment search service.
Return	`osid.inventory.shipment.ShipmentSearchSession`		a `ShipmentSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentSearch()` is `true.`
Method	getShipmentSearchSessionForWarehouse
Description	Gets the `OsidSession` associated with the shipment search service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentSearchSession`		a `ShipmentSearchSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentSearch()` and `supportsVisibleFederation()` are `true`
Method	getShipmentAdminSession
Description	Gets the `OsidSession` associated with the shipment administration service.
Return	`osid.inventory.shipment.ShipmentAdminSession`		a `ShipmentAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentAdmin()` is `true.`
Method	getShipmentAdminSessionForWarehouse
Description	Gets the `OsidSession` associated with the shipment administration service for the given warehouse.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentAdminSession`		a `ShipmentAdminSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentAdmin()` and `supportsVisibleFederation()` are `true`
Method	getShipmentNotificationSession
Description	Gets the `OsidSession` associated with the shipment notification service.
Parameters	`osid.inventory.shipment.ShipmentReceiver`	`shipmentReceiver`	the notification callback
Return	`osid.inventory.shipment.ShipmentNotificationSession`		a `ShipmentNotificationSession`
Errors	NULL_ARGUMENT		`shipmentReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentNotification()` is `true.`
Method	getShipmentNotificationSessionForWarehouse
Description	Gets the `OsidSession` associated with the shipment notification service for the given warehouse.
Parameters	`osid.inventory.shipment.ShipmentReceiver`	`shipmentReceiver`	the notification callback
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentNotificationSession`		a `ShipmentNotificationSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`shipmentReceiver` or `warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentNotification()` and `supportsVisibleFederation()` are `true`
Method	getShipmentWarehouseSession
Description	Gets the `OsidSession` to lookup shipment/catalog mappings.
Return	`osid.inventory.shipment.ShipmentWarehouseSession`		a `ShipmentShipmentWarehouseSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentWarehouse()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentWarehouse()` is `true.`
Method	getShipmentWarehouseAssignmentSession
Description	Gets the `OsidSession` associated with assigning shipments to warehouses.
Return	`osid.inventory.shipment.ShipmentWarehouseAssignmentSession`		a `ShipmentWarehouseAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsShipmentWarehouseAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentWarehouseAssignment()` is `true.`
Method	getShipmentSmartWarehouseSession
Description	Gets the `OsidSession` associated with the shipment smart warehouse service.
Parameters	`osid.id.Id`	`warehouseId`	the `Id` of the `Warehouse`
Return	`osid.inventory.shipment.ShipmentSmartWarehouseSession`		a `ShipmentSmartWarehouseSession`
Errors	NOT_FOUND		no warehouse found by the given `Id`
	NULL_ARGUMENT		`warehouseId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsShipmentSmartWarehouse()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsShipmentSmartWarehouse()` and `supportsVisibleFederation()` are `true`
Method	getInventoryShipmentBatchManager
Description	Gets the `InventoryShipmentBatchManager.`
Return	`osid.inventory.shipment.batch.InventoryShipmentBatchManager`		an `InventoryShipmentBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsInventoryShipmentBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsInventoryShipmentBatch()` is `true.`