Interface InventoryShipmentBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, InventoryShipmentBatchProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface InventoryShipmentBatchProxyManager
extends OsidProxyManager, InventoryShipmentBatchProfile

The inventory shipment batch proxy manager provides access to inventory shipment batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• ShipmentBatchAdminSession: a session to manage shipmentd in bulk

InventoryShipmentBatchProxyManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
ShipmentBatchAdminSession	getShipmentBatchAdminSession(Proxy proxy)	Gets the OsidSession associated with the bulk shipment administration service.
ShipmentBatchAdminSession	getShipmentBatchAdminSessionForWarehouse(Id warehouseId, Proxy proxy)	Gets the OsidSession associated with the bulk shipment administration service for the given warehouse.

Methods inherited from interface Closeable

close

Methods inherited from interface InventoryShipmentBatchProfile

supportsShipmentBatchAdmin, supportsVisibleFederation

Methods inherited from interface OsidProfile

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

Methods inherited from interface OsidProxyManager

close

Methods inherited from interface OsidProxyManager

changeBranch, getProxy, getProxyCondition, initialize, rollbackService

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getShipmentBatchAdminSession

ShipmentBatchAdminSession getShipmentBatchAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the bulk shipment administration service.

Parameters:

proxy - a proxy

Returns:

a ShipmentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsShipmentBatchAdmin()} is {@code true}.

getShipmentBatchAdminSessionForWarehouse

ShipmentBatchAdminSession getShipmentBatchAdminSessionForWarehouse(Id warehouseId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

warehouseId - the Id of the Warehouse

proxy - a proxy

Returns:

a ShipmentBatchAdminSession

Throws:

NotFoundException - no Warehouse found by the given Id

NullArgumentException - warehouseId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsShipmentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsShipmentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}