OSID Logo
OSID Specifications
course syllabus package
Version 3.1.0
Interfaceosid.course.syllabus.DocetCourseCatalogAssignmentSession
Implementsosid.OsidSession
Used Byosid.course.syllabus.CourseSyllabusManager
osid.course.syllabus.CourseSyllabusProxyManager
Description

This session provides methods to re-assign Docets to CourseCatalogs. A Docet may map to multiple CourseCatalogs and removing the last reference to a 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 a 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
Compliancemandatory This 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.IdcourseCatalogId the Id of the CourseCatalog
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT courseCatalogId is null
Compliancemandatory This 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.IdcourseCatalogId the Id of the CourseCatalog
Returnosid.id.IdList list of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdcourseCatalogId the Id of the CourseCatalog
osid.id.IddocetId the Id of the Docet
Returnosid.id.IdList list of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or docetId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignDocetToCourseCatalog
Description

Adds an existing Docet to an CourseCatalog.

Parametersosid.id.IddocetId the Id of the Docet
osid.id.IdcourseCatalogId the Id of the CourseCatalog
ErrorsNOT_FOUND docetId or courseCatalogId not found
NULL_ARGUMENT docetId or courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDocetFromCourseCatalog
Description

Removes a Docet from an CourseCatalog.

Parametersosid.id.IddocetId the Id of the Docet
osid.id.IdcourseCatalogId the Id of the CourseCatalog
ErrorsNOT_FOUND docetId or courseCatalogId not found
NULL_ARGUMENT docetId or courseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignDocetToCourseCatalog
Description

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

Parametersosid.id.IddocetId the Id of the Docet
osid.id.IdfromCourseCatalogId the Id of the current CourseCatalog
osid.id.IdtoCourseCatalogId the Id of the destination CourseCatalog
ErrorsALREADY_EXISTS docetId already assigned to toCourseCatalogId
NOT_FOUND docetId, fromCourseCatalogId, or toCourseCatalogId not found or docetId not mapped to fromCourseCatalogId
NULL_ARGUMENT docetId, fromCourseCatalogId, or toCourseCatalogId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.