OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.CourseEntryCourseCatalogAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign CourseEntries to CourseCatalogs. A CourseEntry may appear in multiple CourseCatalogs and removing the last reference to a CourseEntry 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 CourseEntry to another CourseCatalog is not a copy operation (eg: does not change its Id ).

MethodcanAssignCourseEntries
Description

Tests if this user can alter course entry/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.
MethodcanAssignCourseEntryToCourseCatalog
Description

Tests if this user can alter course entry/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 lookup 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 course entry 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.
MethodgetAssignableCourseCatalogIdsForCourseEntry
Description

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

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

Adds an existing CourseEntry to a CourseCatalog.

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

Removes a CourseEntry from a CourseCatalog.

Parametersosid.id.IdcourseEntryIdthe Id of the CourseEntry
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND courseEntryId or courseCatalogId not found or courseEntryId not assigned to courseCatalogId
NULL_ARGUMENT courseEntryId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCourseEntryToCourseCatalog
Description

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

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