Interface CourseOfferingBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, CourseOfferingAdminSession, OsidSession, OsidSession
public interface CourseOfferingBatchAdminSession extends CourseOfferingAdminSession

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

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

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

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

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

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