OSID Logo
OSID Specifications
course registration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.registration.RegistrationCourseCatalogAssignmentSession
Implementsosid.OsidSession
Description

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

MethodcanAssignRegistrations
Description

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

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

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

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

Adds an existing Registration to a CourseCatalog.

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

Removes a Registration from a CourseCatalog.

Parametersosid.id.IdregistrationIdthe Id of the Registration
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND registrationId or courseCatalogId not found or registrationId not assigned to courseCatalogId
NULL_ARGUMENT registrationId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignRegistrationToCourseCatalog
Description

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

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