Interface InventoryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, InventoryAdminSession, OsidSession, OsidSession
public interface InventoryBatchAdminSession extends InventoryAdminSession

This session creates, updates, and deletes Inventories 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 an Inventory , an InventoryForm is requested using getInventoryFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned InventoryForms 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 an InventoryForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each InventoryForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Inventories in bulk. Bulk delete operations return the results in DeleteResponses .