org.osid.inventory.shipment.batch

Interface InventoryShipmentBatchManager

All Superinterfaces:

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

public interface InventoryShipmentBatchManager
extends OsidManager, InventoryShipmentBatchProfile

The inventory shipment batch manager provides access to inventory shipment batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• ShipmentBatchAdminSession: a session to create, modify and delete Shipments in bulk

Method Summary

Methods

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

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

Gets the OsidSession associated with the bulk shipment administration service.

Returns:

a ShipmentBatchAdminSession

Throws:

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

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

Parameters:

warehouseId - the Id of the Warehouse

Returns:

a ShipmentBatchAdminSession

Throws:

NotFoundException - no Warehouse found by the given Id

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