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

This session provides methods to retrieve Program to CourseCatalog mappings. A Program 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
MethodcanLookupCourseCatalogMappings
Description

Tests if this user can perform lookups of program/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.
MethoduseComparativeCourseCatalogView
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.
MethodusePlenaryCourseCatalogView
Description

A complete view of the Program 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.
MethodgetProgramIdsByCourseCatalog
Description

Gets the list of Program Ids associated with a CourseCatalog.

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

Gets the list of Programs associated with a CourseCatalog.

Parametersosid.id.IdcourseCatalogId Id of the CourseCatalog
Returnosid.course.program.ProgramListlist of related programs
ErrorsNOT_FOUND courseCatalogId is not found
NULL_ARGUMENT courseCatalogId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramIdsByCourseCatalogs
Description

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

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

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

Parametersosid.id.IdListcourseCatalogIdslist of course catalog Ids
Returnosid.course.program.ProgramListlist of programs
ErrorsNULL_ARGUMENT courseCatalogIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogIdsByProgram
Description

Gets the CourseCatalog Ids mapped to a Program.

Parametersosid.id.IdprogramId Id of a Program
Returnosid.id.IdListlist of course catalog Ids
ErrorsNOT_FOUND programId is not found
NULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalogsByProgram
Description

Gets the CourseCatalog objects mapped to a Program.

Parametersosid.id.IdprogramId Id of a Program
Returnosid.course.CourseCatalogListlist of course catalogs
ErrorsNOT_FOUND programId is not found
NULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.