OSID Logo
OSID Specifications
course syllabus package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.ModuleCourseCatalogAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Modules to Course Catalogs. A Module may map to multiple CourseCatalogs and removing the last reference to a Module is the equivalent of deleting it. Each CourseCatalog may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Module to another CourseCatalog is not a copy operation (eg: does not change its Id ).

MethodcanAssignModules
Description

Tests if this user can alter module/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignModulesToCourseCatalog
Description

Tests if this user can alter module/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseCatalogId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCourseCatalogIds
Description

Gets a list of course catalogs including and under the given course catalog node in which any module can be assigned.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableCourseCatalogIdsForModule
Description

Gets a list of course catalogs including and under the given course catalog node in which a specific module can be assigned.

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.id.IdmoduleIdthe Id of the Module
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or moduleId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignModuleToCourseCatalog
Description

Adds an existing Module to an CourseCatalog.

Parametersosid.id.IdmoduleIdthe Id of the Module
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsALREADY_EXISTS moduleId is already assigned to courseCatalogId
NOT_FOUND moduleId or courseCatalogId not found
NULL_ARGUMENT moduleId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignModuleFromCourseCatalog
Description

Removes a Module from an CourseCatalog.

Parametersosid.id.IdmoduleIdthe Id of the Module
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND moduleId or courseCatalogId not found or moduleId not assigned to courseCatalogId
NULL_ARGUMENT moduleId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignModuleToCourseCatalog
Description

Moves a Module from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

Parametersosid.id.IdmoduleIdthe Id of the Module
osid.id.IdfromCourseCatalogIdthe Id of the current CourseCatalog
osid.id.IdtoCourseCatalogIdthe Id of the destination CourseCatalog
ErrorsNOT_FOUND moduleId, fromCourseCatalogId, or toCourseCatalogId not found or moduleId not mapped to fromCourseCatalogId
NULL_ARGUMENT moduleId fromCourseCatalogId, or toCourseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.