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

This session defines methods for retrieving entriesand entry components.

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

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

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

Tests if this user can perform AwardEntry 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.
MethoduseComparativeAwardEntryView
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.
MethodusePlenaryAwardEntryView
Description

A complete view of the AwardEntry 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 awards 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.
MethoduseEffectiveAwardEntryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseAnyEffectiveAwardEntryView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetAwardEntry
Description

Gets the AwardEntry specified by its Id.

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

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

Parametersosid.id.IdawardEntryIdthe Id of the AwardEntry to retrieve
Returnosid.course.chronicle.AwardEntrythe returned chronicle
ErrorsNOT_FOUNDno AwardEntry found with the given Id
NULL_ARGUMENT awardEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesByIds
Description

Gets an AwardEntryList corresponding to the given IdList.

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

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

Parametersosid.id.IdListawardEntryIdthe list of Ids to retrieve
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT awardEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesByGenusType
Description

Gets an AwardEntryList corresponding to the given award entry genus Type which does not include awards of types derived from the specified Type.

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

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

Parametersosid.type.TypeawardEntryGenusTypean award entry genus type
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList
ErrorsNULL_ARGUMENT awardEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesByParentGenusType
Description

Gets an AwardEntryList corresponding to the given award entry genus Type and include any additional awards with genus types derived from the specified Type.

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

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

Parametersosid.type.TypeawardEntryGenusTypean award entry genus type
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList
ErrorsNULL_ARGUMENT awardEntryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesByRecordType
Description

Gets an AwardEntryList containing the given award entry record Type.

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

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

Parametersosid.type.TypeawardEntryRecordTypean award entry record type
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList list
ErrorsNULL_ARGUMENT awardEntryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesOnDate
Description

Gets an AwardEntryList effective during the entire given date range inclusive but not confined to the date range.

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

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

Parametersosid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList 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.
MethodgetAwardEntriesForStudent
Description

Gets an AwardEntryList for the given student .

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

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

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

Gets an AwardEntryList 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 awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session.

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

Parametersosid.id.IdresourceIda resource Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList 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.
MethodgetAwardEntriesForAward
Description

Gets an AwardEntryList for the given award.

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

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

Parametersosid.id.IdawardIdan award Id
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList list
ErrorsNULL_ARGUMENT awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesForAwardOnDate
Description

Gets an AwardEntryList for the given award effective during the entire given date range inclusive but not confined to the date range.

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

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

Parametersosid.id.IdawardIdan award Id
osid.calendaring.DateTimefromstarting date
osid.calendaring.DateTimetoending date
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT awardId, from , or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesForStudentAndAward
Description

Gets an AwardEntryList for the given student and award .

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

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

Parametersosid.id.IdresourceIda resource Id
osid.id.IdawardIdan award Id
Returnosid.course.chronicle.AwardEntryListthe returned AwardEntryList list
ErrorsNULL_ARGUMENT resourceId or awardId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntriesForStudentAndAwardOnDate
Description

Gets an AwardEntryList for the given student and award effective during the entire given date range inclusive but not confined to the date range.

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

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

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

Gets all AwardEntries.

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

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

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