Interface AddressBookBatchAdminSession

All Superinterfaces:
AddressBookAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AddressBookBatchAdminSession extends AddressBookAdminSession

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

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

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

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

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

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