OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.EnrollmentCourseCatalogAssignmentSession
Implementsosid.OsidSession
Description

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

MethodcanAssignEnrollments
Description

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

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

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

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

Adds an existing Enrollment to a CourseCatalog.

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

Removes an Enrollment from a CourseCatalog.

Parametersosid.id.IdenrollmentIdthe Id of the Enrollment
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND enrollmentId or courseCatalogId not found or enrollmentId not assigned to courseCatalogId
NULL_ARGUMENT enrollmentId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignEnrollmeentToCourseCatalog
Description

Moves an Enrollment from one CourseCatalog to another. Mappings to other CourseCatalogs are unaffected.

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