Interface ShipmentBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ShipmentAdminSession
public interface ShipmentBatchAdminSession extends ShipmentAdminSession

This session creates, updates, and deletes Shipments in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Shipment , a ShipmentForm is requested using getShipmentFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned ShipmentForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a ShipmentForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each ShipmentForm corresponds to an attempted transaction.

The ShipmentForms returned from getShipmentFormsForCreate() may be linked to the originating request through the peer Ids of the ShipmentForm . In the case where there may be duplicates, any ShipmentForm of the same peer Ids may be used for a create operation.

Once a batch of ShipmentForms are submitted for create, a CreateResponse is returned for each ShipmentForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createShipments() , errors specific to an individual ShipmentForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating ShipmentForm through the ShipmentForm Id .

For updates, ShipmentForms are requested to the Shipment Id that is to be updated using getShipmentFormsForUpdate() where the reference Id in the ShipmentForm may be used to link the request. Similarly, the ShipmentForm has metadata about the data that can be updated and it can perform validation before submitting the update. The ShipmentForm can only be used once for a successful update and cannot be reused.

Once a batch of ShipmentForms are submitted for update, an UpdateResponse is returned for each ShipmentForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateShipments() , errors specific to an individual ShipmentForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating ShipmentForm through the ShipmentForm Id .

The delete operations delete Shipments in bulk. To unmap a Shipment from the current Warehouse , the ShipmentWarehouseAssignmentSession should be used. These delete operations attempt to remove the Shipment itself thus removing it from all known Warehouse catalogs. Bulk delete operations return the results in DeleteResponses .