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

This session provides methods to re-assign Docets to Course Catalogs. An Docet may map to multiple CourseCatalogs and removing the last reference to an Docet 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 an Docet to another CourseCatalog is not a copy operation (eg: does not change its Id ).

MethodcanAssignDocets
Description

Tests if this user can alter docet/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.
MethodcanAssignDocetsToCourseCatalog
Description

Tests if this user can alter docet/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 docet 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.
MethodgetAssignableCourseCatalogIdsForDocet
Description

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

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

Adds an existing Docet to an CourseCatalog.

Parametersosid.id.IddocetIdthe Id of the Docet
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND docetId or courseCatalogId not found
NULL_ARGUMENT docetId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignDocetFromCourseCatalog
Description

Removes an Docet from an CourseCatalog.

Parametersosid.id.IddocetIdthe Id of the Docet
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND docetId or courseCatalogId not found
NULL_ARGUMENT docetId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignDocetToCourseCatalog
Description

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

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