Interface OrganizationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OrganizationAdminSession, OsidSession, OsidSession
public interface OrganizationBatchAdminSession extends OrganizationAdminSession

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

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

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

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

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

The delete operations delete Organizations in bulk. To unmap an Organization from the current Realm , the OrganizationRealmAssignmentSession should be used. These delete operations attempt to remove the Organization itself thus removing it from all known Realm catalogs. Bulk delete operations return the results in DeleteResponses .