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

This session manages queries and sequencing to create "smart" dynamic catalogs. A RegistrationQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Registrations. The registrations may be sequenced using the RegistrationSearchOrder from this session.

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

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

Gets a registration query.

Returnosid.course.registration.RegistrationQuerythe registration query
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationSearchOrder
Description

Gets a registration search order.

Returnosid.course.registration.RegistrationSearchOrderthe registration search order
CompliancemandatoryThis method must be implemented.
MethodapplyRegistrationQuery
Description

Applies a registration query to this course catalog.

Parametersosid.course.registration.RegistrationQueryregistrationQuerythe registration query
ErrorsNULL_ARGUMENT registrationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED registrationQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectRegistrationQuery
Description

Gets a registration query inspector for this course catalog.

Returnosid.course.registration.RegistrationQueryInspectorthe registration query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyRegistrationSequencing
Description

Applies a registration search order to this course catalog.

Parametersosid.course.registration.RegistrationSearchOrderregistrationSearchOrderthe registration search order
ErrorsNULL_ARGUMENT registrationSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED registrationSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationQueryFromInspector
Description

Gets a registration query from an inspector.

Parametersosid.course.registration.RegistrationQueryInspectorregistrationQueryInspectora query inspector
Returnosid.course.registration.RegistrationQuerythe registration query
ErrorsNULL_ARGUMENT registrationQueryInspector is null
UNSUPPORTED registrationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.