org.osid.inventory.shipment.batch

Interface InventoryShipmentBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, InventoryShipmentBatchProfile, OsidProfile, 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

Method Summary

Methods

Modifier and Type	Method and 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 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.batch.InventoryShipmentBatchProfile

supportsShipmentBatchAdmin, 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

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 supportsShipmentBatchAdmin() is 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 supportsShipmentBatchAdmin() and supportsVisibleFederation() are true