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

This session provides methods to retrieve ActivityRegistration to CourseCatalog mappings. An ActivityRegistration may appear in multiple CourseCatalog objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupActivityRegistrationCourseCatalogMappings
Description

Tests if this user can perform lookups of activity registration/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActivityRegistrationCourseCatalogView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryActivityRegistrationCourseCatalogView
Description

A complete view of the ActivityRegistration and CourseCatalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetActivityRegistrationIdsByCourseCatalog
Description

Gets the list of ActivityRegistration Ids associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.id.IdListlist of related activity registration Ids
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByCourseCatalog
Description

Gets the list of ActivityRegistrations associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.course.registration.ActivityRegistrationListlist of related activity registrations
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationIdsByCourseCatalogs
Description

Gets the list of ActivityRegistration Ids corresponding to a list of CourseCatalog objects.

Parametersosid.id.IdListcourseCatalogIdListlist of course catalog Ids
Returnosid.id.IdListlist of activity registration Ids
ErrorsNULL_ARGUMENT courseCatalogIdList is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityRegistrationsByCourseCatalogs
Description

Gets the list of ActivityRegistrations corresponding to a list of CourseCatalog objects.

Parametersosid.id.IdListcourseCatalogIdListlist of course catalog Ids
Returnosid.course.registration.ActivityRegistrationListlist of activity registrations
ErrorsNULL_ARGUMENT courseCatalogIdList is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByActivityRegistration
Description

Gets the CourseCatalog Ids mapped to an ActivityRegistration.

Parametersosid.id.IdactivityRegistrationId Id of an ActivityRegistration
Returnosid.id.IdListlist of course catalogs
ErrorsNOT_FOUND activityRegistrationId is not found
NULL_ARGUMENT activityRegistrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByActivityRegistration
Description

Gets the CourseCatalog objects mapped to an ActivityRegistration.

Parametersosid.id.IdactivityRegistrationId Id of an ActivityRegistration
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUND activityRegistrationId is not found
NULL_ARGUMENT activityRegistrationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.