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

This session manages queries and sequencing to create "smart" dynamic catalogs. A TermQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Terms. The terms may be sequenced using the TermSearchOrder from this session.

This CourseCatalog has a default query that matches any term and a default search order that specifies no sequencing. The queries may be examined using a TermQueryInspector. The query may be modified by converting the inspector back to a TermQuery.

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

Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returnboolean false if smart course catalog management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTermQuery
Description

Gets a term query.

Returnosid.course.TermQuerythe term query
CompliancemandatoryThis method must be implemented.
MethodgetTermSearchOrder
Description

Gets a term search order.

Returnosid.course.TermSearchOrderthe term search order
CompliancemandatoryThis method must be implemented.
MethodapplyTermQuery
Description

Applies a term query to this course catalog.

Parametersosid.course.TermQuerytermQuerythe term query
ErrorsNULL_ARGUMENT termQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED termQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectTermQuery
Description

Gets a term query inspector for this course catalog.

Returnosid.course.TermQueryInspectorthe term query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyTermSequencing
Description

Applies a term search order to this course catalog.

Parametersosid.course.TermSearchOrdertermSearchOrderthe term search order
ErrorsNULL_ARGUMENT termSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED termSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTermQueryFromInspector
Description

Gets a term query from an inspector.

Parametersosid.course.TermQueryInspectortermQueryInspectora query inspector
Returnosid.course.TermQuerythe term query
ErrorsNULL_ARGUMENT termQueryInspector is null
UNSUPPORTED termQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.