Interface ProgramOfferingBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession, ProgramAdminSession
public interface ProgramOfferingBatchAdminSession extends ProgramAdminSession

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

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

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

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

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

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