Interface CourseRegistrationBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CourseRegistrationAdminSession, OsidSession, OsidSession
public interface CourseRegistrationBatchAdminSession extends CourseRegistrationAdminSession

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

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

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

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

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

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