Interface RealmBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RealmAdminSession
public interface RealmBatchAdminSession extends RealmAdminSession

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

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

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

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

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

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