Interface AccountBatchAdminSession

All Superinterfaces:
AccountAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AccountBatchAdminSession extends AccountAdminSession

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

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

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

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

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

The delete operations delete Accounts in bulk. To unmap an Account from the current Business , the AccountBusinessAssignmentSession should be used. These delete operations attempt to remove the Account itself thus removing it from all known Business catalogs. Bulk delete operations return the results in DeleteResponses .