Interface DistributorBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, DistributorAdminSession, OsidSession, OsidSession
public interface DistributorBatchAdminSession extends DistributorAdminSession

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

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

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

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

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

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