Interface PersonBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, PersonAdminSession
public interface PersonBatchAdminSession extends PersonAdminSession

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

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

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

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

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

The delete operations delete Persons in bulk. To unmap a Person from the current Realm , the PersonRealmAssignmentSession should be used. These delete operations attempt to remove the Person itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses .