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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProgramQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Programs. The courses may be sequenced using the ProgramSearchOrder from this session.

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

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

Gets a program query.

Returnosid.course.program.ProgramQuerythe program query
CompliancemandatoryThis method must be implemented.
MethodgetProgramSearchOrder
Description

Gets a program search order.

Returnosid.course.program.ProgramSearchOrderthe program search order
CompliancemandatoryThis method must be implemented.
MethodapplyProgramQuery
Description

Applies a program query to this course catalog.

Parametersosid.course.program.ProgramQueryprogramQuerythe program query
ErrorsNULL_ARGUMENT programQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED programQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectProgramQuery
Description

Gets a program query inspector for this course catalog.

Returnosid.course.program.ProgramQueryInspectorthe program query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyProgramSequencing
Description

Applies a program search order to this course catalog.

Parametersosid.course.program.ProgramSearchOrderprogramSearchOrderthe program search order
ErrorsNULL_ARGUMENT programSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED programSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetProgramQueryFromInspector
Description

Gets a program query from an inspector.

Parametersosid.course.program.ProgramQueryInspectorprogramQueryInspectora query inspector
Returnosid.course.program.ProgramQuerythe program query
ErrorsNULL_ARGUMENT programQueryInspector is null
UNSUPPORTED programQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.