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

This session provides methods to retrieve ActivityBundle to CourseCatalog mappings. An ActivityBundle 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
MethodcanLookupActivityBundleCourseCatalogMappings
Description

Tests if this user can perform lookups of activity bundle/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.
MethoduseComparativeActivityBundleCourseCatalogView
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.
MethodusePlenaryActivityBundleCourseCatalogView
Description

A complete view of the ActivityBundle 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.
MethodgetActivityBundleIdsByCourseCatalog
Description

Gets the list of ActivityBundle Ids associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.id.IdListlist of related activity bundle 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.
MethodgetActivityBundlesByCourseCatalog
Description

Gets the list of ActivityBundles associated with a CourseCatalog.

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

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

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

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

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.registration.ActivityBundleListlist of activity bundles
ErrorsNULL_ARGUMENT courseCatalogIdList is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByActivityBundle
Description

Gets the CourseCatalog Ids mapped to an ActivityBundle.

Parametersosid.id.IdactivityBundleId Id of an ActivityBundle
Returnosid.id.IdListlist of course catalogs
ErrorsNOT_FOUND activityBundleId is not found
NULL_ARGUMENT activityBundleId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByActivityBundle
Description

Gets the CourseCatalog objects mapped to an ActivityBundle.

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