Interface | osid.inventory.shipment.InventoryShipmentProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.inventory.shipment.InventoryShipmentProfile | |||
Description |
The inventory shipment manager provides access to shipment
sessions and provides interoperability tests for various
aspects of this service. Methods in this manager support the
passing of a
| ||
Method | getShipmentLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentLookupSession | a ShipmentLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentLookup() is false | ||
Compliance | optional | This method must be implemented if supportsShipmentLookup()
is true. | |
Method | getShipmentLookupSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentLookupSession | a ShipmentLookupSession | |
Errors | NOT_FOUND | no Warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentQuerySession | a ShipmentQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentQuery() is false | ||
Compliance | optional | This method must be implemented if supportsShipmentQuery()
is true. | |
Method | getShipmentQuerySessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentQuerySession | a ShipmentQuerySession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentSearchSession | a ShipmentSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentSearch() is false | ||
Compliance | optional | This method must be implemented if supportsShipmentSearch()
is true. | |
Method | getShipmentSearchSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentSearchSession | a ShipmentSearchSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentAdminSession | a ShipmentAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsShipmentAdmin()
is true. | |
Method | getShipmentAdminSessionForWarehouse | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentAdminSession | a ShipmentAdminSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | proxy or 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 | ||
Parameters | osid.inventory.shipment.ShipmentReceiver | shipmentReceiver | the notification callback |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentNotificationSession | a ShipmentNotificationSession | |
Errors | NULL_ARGUMENT | shipmentReceiver or proxy 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 | ||
Parameters | osid.inventory.shipment.ShipmentReceiver | shipmentReceiver | the notification callback |
osid.id.Id | warehouseId | the Id of the Warehouse | |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentNotificationSession | a ShipmentNotificationSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | shipmentReceiver, warehouseId or proxy 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 | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentWarehouseSession | a ShipmentWarehouseSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentWarehouse() is false | ||
Compliance | optional | This method must be implemented if supportsShipmentWarehouse()
is true. | |
Method | getShipmentWarehouseAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | proxy |
Return | osid.inventory.shipment.ShipmentWarehouseAssignmentSession | a ShipmentWarehouseAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsShipmentWarehouseAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsShipmentWarehouseAssignment() is true. | |
Method | getShipmentSmartWarehouseSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | warehouseId | the Id of the Warehouse |
osid.proxy.Proxy | proxy | proxy | |
Return | osid.inventory.shipment.ShipmentSmartWarehouseSession | a ShipmentSmartWarehouseSession | |
Errors | NOT_FOUND | no warehouse found by the given Id | |
NULL_ARGUMENT | warehouseId or proxy 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 | getInventoryShipmentBatchProxyManager | ||
Description |
Gets the | ||
Return | osid.inventory.shipment.batch.InventoryShipmentBatchProxyManager | an InventoryShipmentBatchProxyManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsInventoryShipmentBatch() is false | ||
Compliance | optional | This method must be implemented if supportsInventoryShipmentBatch()
is true. |