Interface InventoryShipmentProxyManager

All Superinterfaces:

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

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

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

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