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

This session manages queries and sequencing to create "smart" dynamic catalogs. A CourseOfferingQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of CourseOfferings. The course offerings may be sequenced using the CourseOfferingSearchOrder from this session.

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

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

Gets a course offering query.

Returnosid.course.CourseOfferingQuerythe course offering query
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingSearchOrder
Description

Gets a course offering search order.

Returnosid.course.CourseOfferingSearchOrderthe course offering search order
CompliancemandatoryThis method must be implemented.
MethodapplyCourseOfferingQuery
Description

Applies a course offering query to this course catalog.

Parametersosid.course.CourseOfferingQuerycourseOfferingQuerythe course offering query
ErrorsNULL_ARGUMENT courseOfferingQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED courseOfferingQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectCourseOfferingQuery
Description

Gets a course offering query inspector for this course catalog.

Returnosid.course.CourseOfferingQueryInspectorthe course offering query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyCourseOfferingSequencing
Description

Applies a course offering search order to this course catalog.

Parametersosid.course.CourseOfferingSearchOrdercourseOfferingSearchOrderthe course offering search order
ErrorsNULL_ARGUMENT courseOfferingSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED courseOfferingSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetCourseOfferingQueryFromInspector
Description

Gets a course offering query from an inspector.

Parametersosid.course.CourseOfferingQueryInspectorcourseOfferingQueryInspectora query inspector
Returnosid.course.CourseOfferingQuerythe course offering query
ErrorsNULL_ARGUMENT courseOfferingQueryInspector is null
UNSUPPORTED courseOfferingQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.