org.osid.inventory.shipment

Interface InventoryShipmentProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InventoryShipmentProfile, OsidProfile, OsidProxyManager, Sourceable

public interface InventoryShipmentProxyManager
extends OsidProxyManager, InventoryShipmentProfile

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

Method Summary

Methods

Modifier and Type	Method and Description
InventoryShipmentBatchProxyManager	getInventoryShipmentBatchProxyManager() Gets the InventoryShipmentBatchProxyManager.
ShipmentAdminSession	getShipmentAdminSession(Proxy proxy) Gets the OsidSession associated with the shipment administration service.
ShipmentAdminSession	getShipmentAdminSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment administration service for the given warehouse.
ShipmentLookupSession	getShipmentLookupSession(Proxy proxy) Gets the OsidSession associated with the shipment lookup service.
ShipmentLookupSession	getShipmentLookupSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment lookup service for the given warehouse.
ShipmentNotificationSession	getShipmentNotificationSession(ShipmentReceiver shipmentReceiver, Proxy proxy) Gets the OsidSession associated with the shipment notification service.
ShipmentNotificationSession	getShipmentNotificationSessionForWarehouse(ShipmentReceiver shipmentReceiver, Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment notification service for the given warehouse.
ShipmentQuerySession	getShipmentQuerySession(Proxy proxy) Gets the OsidSession associated with the shipment query service.
ShipmentQuerySession	getShipmentQuerySessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment query service for the given warehouse.
ShipmentSearchSession	getShipmentSearchSession(Proxy proxy) Gets the OsidSession associated with the shipment search service.
ShipmentSearchSession	getShipmentSearchSessionForWarehouse(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment search service for the given warehouse.
ShipmentSmartWarehouseSession	getShipmentSmartWarehouseSession(Id warehouseId, Proxy proxy) Gets the OsidSession associated with the shipment smart warehouse service.
ShipmentWarehouseAssignmentSession	getShipmentWarehouseAssignmentSession(Proxy proxy) Gets the OsidSession associated with assigning shipments to warehouses.
ShipmentWarehouseSession	getShipmentWarehouseSession(Proxy proxy) Gets the OsidSession to lookup shipment/catalog mappings.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.inventory.shipment.InventoryShipmentProfile

getEntryRecordTypes, getEntrySearchRecordTypes, getShipmentRecordTypes, getShipmentSearchRecordTypes, supportsEntryRecordType, supportsEntrySearchRecordType, supportsInventoryShipmentBatchBatch, supportsShipmentAdmin, supportsShipmentLookup, supportsShipmentNotification, supportsShipmentQuery, supportsShipmentRecordType, supportsShipmentSearch, supportsShipmentSearchRecordType, supportsShipmentSmartWarehouse, supportsShipmentWarehouse, supportsShipmentWarehouseAssignment, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getShipmentLookupSession

ShipmentLookupSession getShipmentLookupSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the shipment lookup service.

Parameters:

proxy - proxy

Returns:

a ShipmentLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentLookup() is false

Compliance:

optional - This method must be implemented if supportsShipmentLookup() is true.

getShipmentLookupSessionForWarehouse

ShipmentLookupSession getShipmentLookupSessionForWarehouse(Id warehouseId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

proxy - proxy

Returns:

a ShipmentLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentLookup() and supportsVisibleFederation() are true

getShipmentQuerySession

ShipmentQuerySession getShipmentQuerySession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the shipment query service.

Parameters:

proxy - proxy

Returns:

a ShipmentQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentQuery() is false

Compliance:

optional - This method must be implemented if supportsShipmentQuery() is true.

getShipmentQuerySessionForWarehouse

ShipmentQuerySession getShipmentQuerySessionForWarehouse(Id warehouseId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ShipmentQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentQuery() and supportsVisibleFederation() are true

getShipmentSearchSession

ShipmentSearchSession getShipmentSearchSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the shipment search service.

Parameters:

proxy - proxy

Returns:

a ShipmentSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentSearch() is false

Compliance:

optional - This method must be implemented if supportsShipmentSearch() is true.

getShipmentSearchSessionForWarehouse

ShipmentSearchSession getShipmentSearchSessionForWarehouse(Id warehouseId,
                                                         Proxy proxy)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ShipmentSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentSearch() and supportsVisibleFederation() are true

getShipmentAdminSession

ShipmentAdminSession getShipmentAdminSession(Proxy proxy)
                                             throws OperationFailedException

Gets the OsidSession associated with the shipment administration service.

Parameters:

proxy - proxy

Returns:

a ShipmentAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentAdmin() is false

Compliance:

optional - This method must be implemented if supportsShipmentAdmin() is true.

getShipmentAdminSessionForWarehouse

ShipmentAdminSession getShipmentAdminSessionForWarehouse(Id warehouseId,
                                                       Proxy proxy)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ShipmentAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - proxy or warehouseId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentAdmin() and supportsVisibleFederation() are true

getShipmentNotificationSession

ShipmentNotificationSession getShipmentNotificationSession(ShipmentReceiver shipmentReceiver,
                                                         Proxy proxy)
                                                           throws OperationFailedException

Gets the OsidSession associated with the shipment notification service.

Parameters:

shipmentReceiver - the notification callback

proxy - proxy

Returns:

a ShipmentNotificationSession

Throws:

NullArgumentException - shipmentReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentNotification() is false

Compliance:

optional - This method must be implemented if supportsShipmentNotification() is true.

getShipmentNotificationSessionForWarehouse

ShipmentNotificationSession getShipmentNotificationSessionForWarehouse(ShipmentReceiver shipmentReceiver,
                                                                     Id warehouseId,
                                                                     Proxy proxy)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

shipmentReceiver - the notification callback

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ShipmentNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - shipmentReceiver, warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentNotification() and supportsVisibleFederation() are true

getShipmentWarehouseSession

ShipmentWarehouseSession getShipmentWarehouseSession(Proxy proxy)
                                                     throws OperationFailedException

Gets the OsidSession to lookup shipment/catalog mappings.

Parameters:

proxy - proxy

Returns:

a ShipmentWarehouseSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentWarehouse() is false

Compliance:

optional - This method must be implemented if supportsShipmentWarehouse() is true.

getShipmentWarehouseAssignmentSession

ShipmentWarehouseAssignmentSession getShipmentWarehouseAssignmentSession(Proxy proxy)
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning shipments to warehouses.

Parameters:

proxy - proxy

Returns:

a ShipmentWarehouseAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentWarehouseAssignment() is false

Compliance:

optional - This method must be implemented if supportsShipmentWarehouseAssignment() is true.

getShipmentSmartWarehouseSession

ShipmentSmartWarehouseSession getShipmentSmartWarehouseSession(Id warehouseId,
                                                             Proxy proxy)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the shipment smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

proxy - proxy

Returns:

a ShipmentSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentSmartWarehouse() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsShipmentSmartWarehouse() and supportsVisibleFederation() are true

getInventoryShipmentBatchProxyManager

InventoryShipmentBatchProxyManager getInventoryShipmentBatchProxyManager()
                                                                         throws OperationFailedException

Gets the InventoryShipmentBatchProxyManager.

Returns:

an InventoryShipmentBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryShipmentBatch() is false

Compliance:

optional - This method must be implemented if supportsInventoryShipmentBatch() is true.