org.osid.inventory.shipment

Interface InventoryShipmentManager

All Superinterfaces:

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

public interface InventoryShipmentManager
extends OsidManager, InventoryShipmentProfile

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 Summary

Methods

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

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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()
                                               throws OperationFailedException

Gets the OsidSession associated with the shipment lookup service.

Returns:

a ShipmentLookupSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the warehouse

Returns:

a ShipmentLookupSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the shipment query service.

Returns:

a ShipmentQuerySession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ShipmentQuerySession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                               throws OperationFailedException

Gets the OsidSession associated with the shipment search service.

Returns:

a ShipmentSearchSession

Throws:

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)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ShipmentSearchSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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()
                                             throws OperationFailedException

Gets the OsidSession associated with the shipment administration service.

Returns:

a ShipmentAdminSession

Throws:

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)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ShipmentAdminSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - 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)
                                                           throws OperationFailedException

Gets the OsidSession associated with the shipment notification service.

Parameters:

shipmentReceiver - the notification callback

Returns:

a ShipmentNotificationSession

Throws:

NullArgumentException - shipmentReceiver 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)
                                                                       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

Returns:

a ShipmentNotificationSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - shipmentReceiver or warehouseId 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()
                                                     throws OperationFailedException

Gets the OsidSession to lookup shipment/catalog mappings.

Returns:

a ShipmentShipmentWarehouseSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentWarehouse() is false

Compliance:

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

getShipmentWarehouseAssignmentSession

ShipmentWarehouseAssignmentSession getShipmentWarehouseAssignmentSession()
                                                                         throws OperationFailedException

Gets the OsidSession associated with assigning shipments to warehouses.

Returns:

a ShipmentWarehouseAssignmentSession

Throws:

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)
                                                               throws NotFoundException,
                                                                      OperationFailedException

Gets the OsidSession associated with the shipment smart warehouse service.

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ShipmentSmartWarehouseSession

Throws:

NotFoundException - no warehouse found by the given Id

NullArgumentException - warehouseId 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

getInventoryShipmentBatchManager

InventoryShipmentBatchManager getInventoryShipmentBatchManager()
                                                               throws OperationFailedException

Gets the InventoryShipmentBatchManager.

Returns:

an InventoryShipmentBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsInventoryShipmentBatch() is false

Compliance:

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