Interface AddressBatchAdminSession

All Superinterfaces:
AddressAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface AddressBatchAdminSession extends AddressAdminSession

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

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

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

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

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

The delete operations delete Addresses in bulk. To unmap an Address from the current AddressBook , the AddressAddressBookAssignmentSession should be used. These delete operations attempt to remove the Address itself thus removing it from all known AddressBook catalogs. Bulk delete operations return the results in DeleteResponses .