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

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

MethodcanAssignActivityRegistrations
Description

Tests if this user can alter activity 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.
MethodcanAssignActivityRegistrationToCourseCatalog
Description

Tests if this user can alter activity 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 activity 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.
MethodgetAssignableCourseCatalogIdsForActivityRegistration
Description

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

Parametersosid.id.IdcourseCatalogIdthe Id of the CourseCatalog
osid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration
Returnosid.id.IdListlist of assignable course catalog Ids
ErrorsNULL_ARGUMENT courseCatalogId or activityRegistrationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignActivityRegistrationToCourseCatalog
Description

Adds an existing ActivityRegistration to a CourseCatalog.

Parametersosid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND activityRegistrationId or courseCatalogId not found
NULL_ARGUMENT activityRegistrationId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignActivityRegistrationFromCourseCatalog
Description

Removes an ActivityRegistration from a CourseCatalog.

Parametersosid.id.IdactivityRegistrationIdthe Id of the ActivityRegistration
osid.id.IdcourseCatalogIdthe Id of the CourseCatalog
ErrorsNOT_FOUND activityRegistrationId or courseCatalogId not found
NULL_ARGUMENT activityRegistrationId or courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignActivityRegistrationToCourseCatalog
Description

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

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