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

This session defines methods for retrieving entries.

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 entry methods in this session operate, retrieve and pertain to program entries defined explicitly in the current course catalog. Using an isolated view is useful for managing ProgramEntries with the ProgramEntry AdminSession.
  • federated course catalog view: All program entry lookup methods in this session operate, retrieve and pertain to all program entries defined in this course catalog and any other program entries implicitly available in this course catalog through course catalog inheritence.
  • effective program entry view: All program entry lookup methods return program entry where the current date falls in between the effective dates inclusive.
  • any program entry view: Program entries of any effective date are returned from methods.

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

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

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

Tests if this user can perform ProgramEntry 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.
MethoduseComparativeProgramEntryView
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.
MethodusePlenaryProgramEntryView
Description

A complete view of the ProgramEntry 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 entries 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.
MethoduseEffectiveProgramEntryView
Description

Only program entries whose effective dates are current are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveProgramEntryView
Description

All program entries of any effective dates are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetProgramEntry
Description

Gets the ProgramEntry specified by its Id.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdprogramEntryIdthe Id of the ProgramEntry to retrieve
Returnosid.course.chronicle.ProgramEntrythe returned ProgramEntry
ErrorsNOT_FOUNDno ProgramEntry found with the given Id
NULL_ARGUMENT programEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesByIds
Description

Gets a ProgramEntryList corresponding to the given IdList.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdListprogramEntryIdthe list of Ids to retrieve
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT programEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesByGenusType
Description

Gets a ProgramEntryList corresponding to the given program entry genus Type which does not include program entries of types derived from the specified Type.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.type.TypeprogramEntryGenusTypea program entry genus type
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNULL_ARGUMENT programEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesByParentGenusType
Description

Gets a ProgramEntryList corresponding to the given program entry genus Type and include any additional program entries with genus types derived from the specified Type.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.type.TypeprogramEntryGenusTypea program entry genus type
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList
ErrorsNULL_ARGUMENT programEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesByRecordType
Description

Gets a ProgramEntryList containing the given program entry record Type.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.type.TypeprogramEntryRecordTypea program entry record type
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsNULL_ARGUMENT programEntryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesOnDate
Description

Gets a ProgramEntryList effective during the entire given date range inclusive but not confined to the date range.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList 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.
MethodgetProgramEntriesForStudent
Description

Gets a ProgramEntryList for the given student .

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesForStudentOnDate
Description

Gets a ProgramEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesForProgram
Description

Gets a ProgramEntryList for the given program.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdprogramIda program Id
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsNULL_ARGUMENT programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesForProgramOnDate
Description

Gets a ProgramEntryList for the given program effective during the entire given date range inclusive but not confined to the date range.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdprogramIda program Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList 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.
MethodgetProgramEntriesForStudentAndProgram
Description

Gets a ProgramEntryList for the given student and program .

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdprogramIda program Id
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsNULL_ARGUMENT resourceId or programId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntriesForStudentAndProgramOnDate
Description

Gets a ProgramEntryList for the given student and program effective during the entire given date range inclusive but not confined to the date range.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Parametersosid.id.IdresourceIda resource Id
osid.id.IdprogramIda program Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.ProgramEntryListthe returned ProgramEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, programId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProgramEntries
Description

Gets all ProgramEntries.

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

In effective mode, program entries are returned that are currently effective. In any effective mode, effective program entries and those currently expired are returned.

Returnosid.course.chronicle.ProgramEntryLista list of ProgramEntries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.