Interface CourseBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CourseAdminSession, OsidSession, OsidSession
public interface CourseBatchAdminSession extends CourseAdminSession

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

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

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

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

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

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