Interface | osid.course.syllabus.batch.ModuleBatchAdminSession | ||
---|---|---|---|
Implements | osid.course.syllabus.ModuleAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getModuleFormsForCreate | ||
Description |
Gets the module forms for creating a bunch of new modules. A new form isreturned for each supplied syllabus. | ||
Parameters | osid.id.IdList | syllabusIds | a list of syllabus Ids |
osid.type.Type[] | moduleRecordTypes | array of module record types to be included in each create operation or an empty list if none | |
Return | osid.course.syllabus.batch.ModuleBatchFormList | the module forms | |
Errors | NOT_FOUND | a syllabusId is no found | |
NULL_ARGUMENT | syllabusIds or moduleRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createModules | ||
Description |
Creates a new set of | ||
Parameters | osid.course.syllabus.batch.ModuleBatchFormList | moduleForms | the module forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | moduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getModuleFormsForUpdate | ||
Description |
Gets the module forms for updating an existing set of modules. A new module form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | moduleIds | the Ids of the Module |
Return | osid.course.syllabus.batch.ModuleBatchFormList | the module form | |
Errors | NOT_FOUND | a moduleId is not found | |
NULL_ARGUMENT | moduleIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateModules | ||
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 | ||
Parameters | osid.course.syllabus.batch.ModuleBatchFormList | moduleForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | moduleForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllModules | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteModules | ||
Description |
Deletes modules for the given | ||
Parameters | osid.id.IdList | moduleIds | the Ids of the modules to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | moduleIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteModulesForSyllabus | ||
Description |
Deletes modules for the given syllabus. | ||
Parameters | osid.id.Id | syllabusId | the Id of a syllabus |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | syllabusId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasModules | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |