Interface EnrollmentBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, EnrollmentAdminSession, OsidSession, OsidSession
public interface EnrollmentBatchAdminSession extends EnrollmentAdminSession

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

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

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

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

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

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