Interface CourseEntryBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CourseEntryAdminSession, OsidSession, OsidSession
public interface CourseEntryBatchAdminSession extends CourseEntryAdminSession

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

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

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

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

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

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