Interface DepotBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DepotAdminSession, OsidSession, OsidSession
public interface DepotBatchAdminSession extends DepotAdminSession

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

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

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

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

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

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