Interface ModuleBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, ModuleAdminSession, OsidSession, OsidSession
public interface ModuleBatchAdminSession extends ModuleAdminSession

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

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

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

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

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

The delete operations delete Modules in bulk. To unmap s Module from the current CourseCatalog , the ModuleCourseCatalogAssignmentSession should be used. These delete operations attempt to remove the Module itself thus removing it from all known CourseCatalog catalogs. Bulk delete operations return the results in DeleteResponses .