OSID Logo
OSID Specifications
course syllabus batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.batch.ModuleBatchAdminSession
Implementsosid.course.syllabus.ModuleAdminSession
Description

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.

MethodgetModuleFormsForCreate
Description

Gets the module forms for creating a bunch of new modules. A new form isreturned for each supplied syllabus.

Parametersosid.id.IdListsyllabusIdsa list of syllabus Ids
osid.type.Type[]moduleRecordTypesarray of module record types to be included in each create operation or an empty list if none
Returnosid.course.syllabus.batch.ModuleBatchFormListthe module forms
ErrorsNOT_FOUNDa syllabusId is no found
NULL_ARGUMENT syllabusIds or moduleRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateModules
Description

Creates a new set of Modules. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.course.syllabus.batch.ModuleBatchFormListmoduleFormsthe module forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT moduleForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetModuleFormsForUpdate
Description

Gets the module forms for updating an existing set of modules. A new module form should be requested for each update transaction.

Parametersosid.id.IdListmoduleIdsthe Ids of the Module
Returnosid.course.syllabus.batch.ModuleBatchFormListthe module form
ErrorsNOT_FOUNDa moduleId is not found
NULL_ARGUMENT moduleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateModules
Description

Updates existing modules. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.course.syllabus.batch.ModuleBatchFormListmoduleFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT moduleForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllModules
Description

Deletes all Modules in this CourseCatalog .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteModules
Description

Deletes modules for the given Ids.

Parametersosid.id.IdListmoduleIdsthe Ids of the modules to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT moduleIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteModulesForSyllabus
Description

Deletes modules for the given syllabus.

Parametersosid.id.IdsyllabusIdthe Id of a syllabus
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT syllabusId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasModules
Description

Adds an Id to a Module for the purpose of creating compatibility. The primary Id of the Module is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another module, it is reassigned to the given module Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.