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

This session defines methods for retrieving program offerings. A ProgramOffering is an offering of a Program in which a student can enroll.

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 offering methods in this session operate, retrieve and pertain to program offerings defined explicitly in the current course catalog. Using an isolated view is useful for managing ProgramOfferings with the ProgramOfferingAdminSession.
  • federated course catalog view: All program offering lookup methods in this session operate, retrieve and pertain to all program offerings defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.
  • effective program offering view: All program offering lookup methods return program offerings where the current date falls within the effective dates inclusive.
  • any effective program offering view: Program offerings of any effective or expired 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.

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

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.
MethodcanLookupProgramOfferings
Description

Tests if this user can perform ProgramOffering 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.
MethoduseComparativeProgramOfferingView
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.
MethodusePlenaryProgramOfferingView
Description

A complete view of the ProgramOffering 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 program offerings 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.
MethoduseEffectiveProgramOfferingView
Description

All program offering methods return program offerings where the current date falls within the effective dates inclusive.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveProgramOfferingView
Description

All methods return program offerings of any effective or expired status.

CompliancemandatoryThis method is must be implemented.
MethodgetProgramOffering
Description

Gets the ProgramOffering specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProgramOffering 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 effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdprogramOfferingIdthe Id of the ProgramOffering to retrieve
Returnosid.course.program.ProgramOfferingthe returned ProgramOffering
ErrorsNOT_FOUNDno ProgramOffering found with the given Id
NULL_ARGUMENT programOfferingId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsByIds
Description

Gets a ProgramOfferingList corresponding to the given IdList.

In plenary mode, the returned list contains all of the program offerings 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 ProgramOfferings may be omitted from the list and may present the elements in any order including returning a unique set.

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdListprogramOfferingIdsthe list of Ids to retrieve
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT programOfferingIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsByGenusType
Description

Gets a ProgramOfferingList corresponding to the given program offering genus Type which does not include program offerings of types derived from the specified Type.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.type.TypeprogramOfferingGenusTypea program offering genus type
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsNULL_ARGUMENT programOfferingGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsByParentGenusType
Description

Gets a ProgramOfferingList corresponding to the given porgram offering genus Type and include any additional program offerings with genus types derived from the specified Type.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.type.TypeprogramOfferingGenusTypea program offering genus type
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsNULL_ARGUMENT programOfferingGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsByRecordType
Description

Gets a ProgramOfferingList containing the given program offering record Type.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.type.TypeprogramOfferingRecordTypea program offering record type
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsNULL_ARGUMENT programOfferingRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsOnDate
Description

Gets a ProgramOfferingList effective within the given date range inclusive.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForProgram
Description

Gets all ProgramOfferings associated with a given Program. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session.

Parametersosid.id.IdprogramIda program Id
Returnosid.course.program.ProgramOfferingLista list of ProgramOfferings
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForProgramOnDate
Description

Gets a ProgramOfferingList for the given program and effective within the given date range inclusive.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdprogramIda program Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT programId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForTerm
Description

Gets all ProgramOfferings associated with a given Term.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdtermIda term Id
Returnosid.course.program.ProgramOfferingLista list of ProgramOfferings
ErrorsNULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForTermOnDate
Description

Gets a ProgramOfferingList for the given term and effective within the given date range inclusive.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdtermIda term Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT termId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForProgramAndTerm
Description

Gets all ProgramOfferings associated with a given Term and Program.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdprogramIda programId Id
osid.id.IdtermIda term Id
Returnosid.course.program.ProgramOfferingLista list of ProgramOfferings
ErrorsNULL_ARGUMENT programId or termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferingsForProgramAndTermOnDate
Description

Gets a ProgramOfferingList for the given program, term, and effective within the given date range inclusive.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parametersosid.id.IdprogramIda program Id
osid.id.IdtermIda term Id
osid.calendaring.DateTimefromstart of date range
osid.calendaring.DateTimetoend of date range
Returnosid.course.program.ProgramOfferingListthe returned ProgramOffering list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT programId, termId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramOfferings
Description

Gets all ProgramOfferings.

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

In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

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