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

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

Tests if this user can perform lookups of activity unit/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.
MethoduseComparativeActivityUnitCourseCatalogView
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.
MethodusePlenaryActivityUnitCatalogView
Description

A complete view of the ActivityUnit 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.
MethodgetActivityUnitIdsByCourseCatalog
Description

Gets the list of ActivityUnit Ids associated with a CourseCatalog.

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

Gets the list of ActivityUnits associated with a CourseCatalog.

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

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

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

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

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.ActivityUnitListlist of activity units
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByActivityUnit
Description

Gets the CourseCatalog Ids mapped to an ActivityUnit.

Parametersosid.id.IdactivityUnitId Id of an ActivityUnit
Returnosid.id.IdListlist of course catalogs
ErrorsNOT_FOUND activityUnitId is not found
NULL_ARGUMENT activityUnitId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByActivityUnit
Description

Gets the CourseCatalog objects mapped to an ActivityUnit.

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