Interface ActivityRegistrationBatchAdminSession

All Superinterfaces:
ActivityRegistrationAdminSession, AutoCloseable, Closeable, OsidSession, OsidSession
public interface ActivityRegistrationBatchAdminSession extends ActivityRegistrationAdminSession

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

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

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

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

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

The delete operations delete ActivityRegistrations in bulk. To unmap an ActivityRegistration from the current CourseCatalog , the ActivityRegistrationCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the ActivityRegistration itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .