OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.InventoryShipmentProxyManager
Implementsosid.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 Proxy for the purposes of passing information within a server application environment. 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
MethodgetShipmentLookupSession
Description

Gets the OsidSession associated with the shipment lookup service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentLookupSessiona ShipmentLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentLookup() is false
ComplianceoptionalThis method must be implemented if supportsShipmentLookup() is true.
MethodgetShipmentLookupSessionForWarehouse
Description

Gets the OsidSession associated with the shipment lookup service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentLookupSessiona ShipmentLookupSession
ErrorsNOT_FOUNDno Warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentLookup() and supportsVisibleFederation() are true
MethodgetShipmentQuerySession
Description

Gets the OsidSession associated with the shipment query service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentQuerySessiona ShipmentQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentQuery() is false
ComplianceoptionalThis method must be implemented if supportsShipmentQuery() is true.
MethodgetShipmentQuerySessionForWarehouse
Description

Gets the OsidSession associated with the shipment query service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentQuerySessiona ShipmentQuerySession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentQuery() and supportsVisibleFederation() are true
MethodgetShipmentSearchSession
Description

Gets the OsidSession associated with the shipment search service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentSearchSessiona ShipmentSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentSearch() is false
ComplianceoptionalThis method must be implemented if supportsShipmentSearch() is true.
MethodgetShipmentSearchSessionForWarehouse
Description

Gets the OsidSession associated with the shipment search service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentSearchSessiona ShipmentSearchSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentSearch() and supportsVisibleFederation() are true
MethodgetShipmentAdminSession
Description

Gets the OsidSession associated with the shipment administration service.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentAdminSessiona ShipmentAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentAdmin() is false
ComplianceoptionalThis method must be implemented if supportsShipmentAdmin() is true.
MethodgetShipmentAdminSessionForWarehouse
Description

Gets the OsidSession associated with the shipment administration service for the given warehouse.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentAdminSessiona ShipmentAdminSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT proxy or warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentAdmin() and supportsVisibleFederation() are true
MethodgetShipmentNotificationSession
Description

Gets the OsidSession associated with the shipment notification service.

Parametersosid.inventory.shipment.ShipmentReceivershipmentReceiverthe notification callback
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentNotificationSessiona ShipmentNotificationSession
ErrorsNULL_ARGUMENT shipmentReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentNotification() is false
ComplianceoptionalThis method must be implemented if supportsShipmentNotification() is true.
MethodgetShipmentNotificationSessionForWarehouse
Description

Gets the OsidSession associated with the shipment notification service for the given warehouse.

Parametersosid.inventory.shipment.ShipmentReceivershipmentReceiverthe notification callback
osid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentNotificationSessiona ShipmentNotificationSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT shipmentReceiver, warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentNotification() and supportsVisibleFederation() are true
MethodgetShipmentWarehouseSession
Description

Gets the OsidSession to lookup shipment/catalog mappings.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentWarehouseSessiona ShipmentWarehouseSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentWarehouse() is false
ComplianceoptionalThis method must be implemented if supportsShipmentWarehouse() is true.
MethodgetShipmentWarehouseAssignmentSession
Description

Gets the OsidSession associated with assigning shipments to warehouses.

Parametersosid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentWarehouseAssignmentSessiona ShipmentWarehouseAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentWarehouseAssignment() is false
ComplianceoptionalThis method must be implemented if supportsShipmentWarehouseAssignment() is true.
MethodgetShipmentSmartWarehouseSession
Description

Gets the OsidSession associated with the shipment smart warehouse service.

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
osid.proxy.Proxyproxyproxy
Returnosid.inventory.shipment.ShipmentSmartWarehouseSessiona ShipmentSmartWarehouseSession
ErrorsNOT_FOUNDno warehouse found by the given Id
NULL_ARGUMENT warehouseId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentSmartWarehouse() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentSmartWarehouse() and supportsVisibleFederation() are true
MethodgetInventoryShipmentBatchProxyManager
Description

Gets the InventoryShipmentBatchProxyManager.

Returnosid.inventory.shipment.batch.InventoryShipmentBatchProxyManageran InventoryShipmentBatchProxyManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsInventoryShipmentBatch() is false
ComplianceoptionalThis method must be implemented if supportsInventoryShipmentBatch() is true.