Interface ProfileEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProfileEntryAdminSession
public interface ProfileEntryBatchAdminSession extends ProfileEntryAdminSession

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

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

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

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

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

The delete operations delete ProfileEntries in bulk. To unmap a ProfileEntry from the current Profile , the ProfileEntryProfileAssignmentSession should be used. These delete operations attempt to remove the ProfileEntry itself thus removing it from all known Profile catalogs. Bulk delete operations return the results in DeleteResponses .