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

This session manages queries and sequencing to create "smart" dynamic catalogs. A LessonQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Lessons. The lessonsmay be sequenced using the LessonSearchOrder from this session.

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

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 CourseCatalog associated with this session
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 authorization. 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.
MethodgetLessonQuery
Description

Gets a lesson query.

Returnosid.course.plan.LessonQuerythe lesson query
CompliancemandatoryThis method must be implemented.
MethodgetLessonSearchOrder
Description

Gets a lesson search order.

Returnosid.course.plan.LessonSearchOrderthe lesson search order
CompliancemandatoryThis method must be implemented.
MethodapplyLessonQuery
Description

Applies a lesson query to this course catalog.

Parametersosid.course.plan.LessonQuerylessonQuerythe lesson query
ErrorsNULL_ARGUMENT lessonQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED lessonQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectLessonQuery
Description

Gets a lesson query inspector for this course catalog.

Returnosid.course.plan.LessonQueryInspectorthe lesson query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyLessonSequencing
Description

Applies a lesson search order to this course catalog.

Parametersosid.course.plan.LessonSearchOrderlessonSearchOrderthe lesson search order
ErrorsNULL_ARGUMENT lessonSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED lessonSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetLessonQueryFromInspector
Description

Gets a lesson query from an inspector.

Parametersosid.course.plan.LessonQueryInspectorlessonQueryInspectora query inspector
Returnosid.course.plan.LessonQuerythe lesson query
ErrorsNULL_ARGUMENT lessonQueryInspector is null
UNSUPPORTED lessonQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.