Interface ItemBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ItemAdminSession, OsidSession, OsidSession
public interface ItemBatchAdminSession extends ItemAdminSession

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

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

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

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

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

The delete operations delete Items in bulk. To unmap an Item from the current Inventory , the ItemInventoryAssignmentSession should be used. These delete operations attempt to remove the Item itself thus removing it from all known Inventory catalogs. Bulk delete operations return the results in DeleteResponses .