Interface RegistrationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, RegistrationAdminSession
public interface RegistrationBatchAdminSession extends RegistrationAdminSession

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

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

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

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

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

The delete operations delete Registrations in bulk. To unmap a Registration from the current CourseCatalog , the RegistrationCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Registration itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .