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

This session defines methods for retrieving programs. A P rogram is canonical and a ProgramOffering is derived from a Program.

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
  • isolated course catalog view: All program methods in this session operate, retrieve and pertain to programs defined explicitly in the current course catalog. Using an isolated view is useful for managing Programs with the Program AdminSession.
  • federated course catalog view: All program lookup methods in this session operate, retrieve and pertain to all programs defined in this course catalog and any other programs implicitly available in this course catalog through course catalog inheritence.
  • active program view: All program lookup methods return active programs.
  • any status program view: Programs of any active or inactive status are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

Programs may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Program.

MethodgetCourseCatalogId
Description

Gets the CourseCatalog Id associated with this session.

Returnosid.id.Idthe CourseCatalog Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetCourseCatalog
Description

Gets the CourseCatalog associated with this session.

Returnosid.course.CourseCatalogthe course catalog
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupPrograms
Description

Tests if this user can perform Program lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeProgramView
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.
MethodusePlenaryProgramView
Description

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

Federates the view for methods in this session. A federated view will include programs in catalogs which are children of this catalog in the course catalog hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedCourseCatalogView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethoduseActiveProgramView
Description

Only active programs are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusProgramView
Description

All programs of any active or inactive status are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetProgram
Description

Gets the Program specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned program may have a different Id than requested, such as the case where a duplicate Id was assigned to a program and retained for compatibility.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.id.IdprogramIdthe Id of the Program to retrieve
Returnosid.course.program.Programthe returned Program
ErrorsNOT_FOUNDno program found with the given Id
NULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramsByIds
Description

Gets a ProgramList corresponding to the given IdList.

In plenary mode, the returned list contains all of the programs specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Programs may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.id.IdListprogramIdsthe list of Ids to retrieve
Returnosid.course.program.ProgramListthe returned ProgramList list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT programIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramsByGenusType
Description

Gets a ProgramList corresponding to the given program genus Type which does not include programs of types derived from the specified Type.

In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.type.TypeprogramGenusTypea program genus type
Returnosid.course.program.ProgramListthe returned ProgramList list
ErrorsNULL_ARGUMENT programGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramsByParentGenusType
Description

Gets a ProgramList corresponding to the given program genus Type and include any additional programs with genus types derived from the specified Type.

In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.type.TypeprogramGenusTypea program genus type
Returnosid.course.program.ProgramListthe returned ProgramList list
ErrorsNULL_ARGUMENT programGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramsByRecordType
Description

Gets a ProgramList containing the given program record Type.

In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.type.TypeprogramRecordTypea program record type
Returnosid.course.program.ProgramListthe returned ProgramList list
ErrorsNULL_ARGUMENT programRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramsByCredential
Description

Gets a ProgramList containing the given creential.

In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Parametersosid.id.IdcredentialIda credential Id
Returnosid.course.program.ProgramListthe returned ProgramList list
ErrorsNULL_ARGUMENT credentialId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPrograms
Description

Gets all Programs.

In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.

In active mode, active programs are returned. In any status mode, active and inactive programs are returned.

Returnosid.course.program.ProgramLista list of Programs
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.