OSID Logo
OSID Specifications
inventory shipment batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.batch.InventoryShipmentBatchManager
Implementsosid.OsidManager
osid.inventory.shipment.batch.InventoryShipmentBatchProfile
Description

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
MethodgetShipmentBatchAdminSession
Description

Gets the OsidSession associated with the bulk shipment administration service.

Returnosid.inventory.shipment.batch.ShipmentBatchAdminSessiona ShipmentBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsShipmentBatchAdmin() is true.
MethodgetShipmentBatchAdminSessionForWarehouse
Description

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

Parametersosid.id.IdwarehouseIdthe Id of the Warehouse
Returnosid.inventory.shipment.batch.ShipmentBatchAdminSessiona ShipmentBatchAdminSession
ErrorsNOT_FOUNDno Warehouse found by the given Id
NULL_ARGUMENT warehouseId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsShipmentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsShipmentBatchAdmin() and supportsVisibleFederation() are true