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

This session provides methods for retrieving Term objects. The Term represents a time period in which courses are offered.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated course catalog view: All term methods in this session operate, retrieve and pertain to terms defined explicitly in the current course catalog. Using an isolated view is useful for managing Terms with the TermAdminSession.
  • federated course catalog view: All term methods in this session operate, retrieve and pertain to all terms defined in this course catalog and any other terms implicitly available in this course catalog through course catalog inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

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

Tests if this user can perform Term 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 opt not to offer lookup operations to unauthorized users.

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

A complete view of the Term 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 terms in course catalogs which are children of this course 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 lookups to this course catalog only.

CompliancemandatoryThis method is must be implemented.
MethodgetTerm
Description

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

Parametersosid.id.IdtermId Id of the Term
Returnosid.course.Termthe term
ErrorsNOT_FOUND termId not found
NULL_ARGUMENT termId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetTermsByIds
Description

Gets a TermList corresponding to the given IdList. In plenary mode, the returned list contains all of the terms 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 Terms may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListtermIdsthe list of Ids to retrieve
Returnosid.course.TermListthe returned Term list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT termIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTermsByGenusType
Description

Gets a TermList corresponding to the given term genus Type which does not include terms of genus types derived from the specified Type. In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.

Parametersosid.type.TypetermGenusTypea term genus type
Returnosid.course.TermListthe returned Term list
ErrorsNULL_ARGUMENT termGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTermsByParentGenusType
Description

Gets a TermList corresponding to the given term genus Type and include any additional terms with genus types derived from the specified Type. In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.

Parametersosid.type.TypetermGenusTypea term genus type
Returnosid.course.TermListthe returned Term list
ErrorsNULL_ARGUMENT termGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTermsByRecordType
Description

Gets a TermList containing the given term record Type. In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.

Parametersosid.type.TypetermRecordTypea term record type
Returnosid.course.TermListthe returned Term list
ErrorsNULL_ARGUMENT termRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTermsByClassesDate
Description

Gets a TermList where to the given DateTime falls within the classes date range inclusive. Terms containing the given date are matched. In plenary mode, the returned list contains all of the terms 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 Terms may be omitted from the list including returning a unique set.

Parametersosid.calendaring.DateTimedatetimea date
Returnosid.course.TermListthe returned Term list
ErrorsNULL_ARGUMENT datetime is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTerms
Description

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

Returnosid.course.TermLista list of Terms
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.