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

This session manages queries and sequencing to create "smart" dynamic catalogs. An EnrollmentQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Enrollments. The enrollments may be sequenced using the EnrollmentSearchOrder from this session.

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

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

Gets an enrollment query.

Returnosid.course.program.EnrollmentQuerythe enrollment query
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentSearchOrder
Description

Gets an enrollment search order.

Returnosid.course.program.EnrollmentSearchOrderthe enrollment search order
CompliancemandatoryThis method must be implemented.
MethodapplyEnrollmentQuery
Description

Applies an enrollment query to this course catalog.

Parametersosid.course.program.EnrollmentQueryenrollmentQuerythe enrollment query
ErrorsNULL_ARGUMENT enrollmentQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED enrollmentQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectEnrollmentQuery
Description

Gets an enrollment query inspector for this course catalog.

Returnosid.course.program.EnrollmentQueryInspectorthe enrollment query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyEnrollmentSequencing
Description

Applies an enrollment search order to this course catalog.

Parametersosid.course.program.EnrollmentSearchOrderenrollmentSearchOrderthe enrollment search order
ErrorsNULL_ARGUMENT enrollmentSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED enrollmentSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEnrollmentQueryFromInspector
Description

Gets an enrollment query from an inspector.

Parametersosid.course.program.EnrollmentQueryInspectorenrollmentQueryInspectora query inspector
Returnosid.course.program.EnrollmentQuerythe enrollment query
ErrorsNULL_ARGUMENT enrollmentQueryInspector is null
UNSUPPORTED enrollmentQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.