Interface ProfileItemBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProfileItemAdminSession
public interface ProfileItemBatchAdminSession extends ProfileItemAdminSession

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

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

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

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

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

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