Interface InventoryShipmentManager

All Superinterfaces:

AutoCloseable, Closeable, InventoryShipmentProfile, OsidManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface InventoryShipmentProfile

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

Modifier and Type	Method	Description
TypeList	getEntryRecordTypes()	Gets the supported Entry record types.
TypeList	getEntrySearchRecordTypes()	Gets the supported Entry search record types.
TypeList	getShipmentRecordTypes()	Gets the supported Shipment record types.
TypeList	getShipmentSearchRecordTypes()	Gets the supported Shipment search record types.
boolean	supportsEntryRecordType(Type entryRecordType)	Tests if the given Entry record type is supported.
boolean	supportsEntrySearchRecordType(Type entrySearchRecordType)	Tests if the given Entry search record type is supported.
boolean	supportsInventoryShipmentBatchBatch()	Tests for the availability of an inventory shipment batch service.
boolean	supportsShipmentAdmin()	Tests if shipment administrative service is supported.
boolean	supportsShipmentLookup()	Tests if looking up shipments is supported.
boolean	supportsShipmentNotification()	Tests if a shipment notification service is supported.
boolean	supportsShipmentQuery()	Tests if querying shipments is supported.
boolean	supportsShipmentRecordType(Type shipmentRecordType)	Tests if the given Shipment record type is supported.
boolean	supportsShipmentSearch()	Tests if searching shipments is supported.
boolean	supportsShipmentSearchRecordType(Type shipmentSearchRecordType)	Tests if the given Shipment search record type is supported.
boolean	supportsShipmentSmartWarehouse()	Tests if a shipment smart warehouse session is available.
boolean	supportsShipmentWarehouse()	Tests if a warehouseing service is supported.
boolean	supportsShipmentWarehouseAssignment()	Tests if a warehouseing service is supported.
boolean	supportsVisibleFederation()	Tests if any warehouse federation is exposed.

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsShipmentLookup()} is {@code 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 {@code supportsShipmentLookup()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsShipmentQuery()} is {@code 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 {@code supportsShipmentQuery()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsShipmentSearch()} is {@code 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 {@code supportsShipmentSearch()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsShipmentAdmin()} is {@code 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 {@code supportsShipmentAdmin()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsShipmentNotification()} is {@code 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 {@code supportsShipmentNotification()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsShipmentWarehouse()} is {@code 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 {@code supportsShipmentWarehouseAssignment()} is {@code 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 {@code supportsShipmentSmartWarehouse()} and {@code supportsVisibleFederation()} are {@code 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 {@code supportsInventoryShipmentBatch()} is {@code true} .