Interface ParticipantBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ParticipantAdminSession
public interface ParticipantBatchAdminSession extends ParticipantAdminSession

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

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

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

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

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

The delete operations delete Participants in bulk. To unmap a Participant from the current Catalogue , the ParticipantCatalogueAssignmentSession should be used. These delete operations attempt to remove the Participant itself thus removing it from all known Catalogue catalogs. Bulk delete operations return the results in DeleteResponses .