Interface BinBatchAdminSession

All Superinterfaces:
AutoCloseable, BinAdminSession, Closeable, OsidSession, OsidSession
public interface BinBatchAdminSession extends BinAdminSession

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

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

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

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

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

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