Interface AgencyBatchAdminSession

All Superinterfaces:
AgencyAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AgencyBatchAdminSession extends AgencyAdminSession

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

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

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

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

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

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