Interface ProfileBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProfileAdminSession
public interface ProfileBatchAdminSession extends ProfileAdminSession

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

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

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

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

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

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