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

This session manages queries and sequencing to create "smart" dynamic catalogs. An ActivityBundleQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of ActivityBundles. The activity bundles may be sequenced using the ActivityBundleSearchOrder from this session.

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

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

Gets an activity bundle query.

Returnosid.course.registration.ActivityBundleQuerythe activity bundle query
CompliancemandatoryThis method must be implemented.
MethodgetActivityBundleSearchOrder
Description

Gets an activity bundle search order.

Returnosid.course.registration.ActivityBundleSearchOrderthe activity bundle search order
CompliancemandatoryThis method must be implemented.
MethodapplyActivityBundleQuery
Description

Applies an activity bundle query to this course catalog.

Parametersosid.course.registration.ActivityBundleQueryactivityBundleQuerythe activity bundle query
ErrorsNULL_ARGUMENT activityBundleQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED activityBundleQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectActivityBundleQuery
Description

Gets an activity bundle query inspector for this course catalog.

Returnosid.course.registration.ActivityBundleQueryInspectorthe activity bundle query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyActivityBundleSequencing
Description

Applies an activity bundle search order to this course catalog.

Parametersosid.course.registration.ActivityBundleSearchOrderactivityBundleSearchOrderthe activity bundle search order
ErrorsNULL_ARGUMENT activityBundleSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED activityBundleSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetActivityBundleQueryFromInspector
Description

Gets an activity bundle query from an inspector.

Parametersosid.course.registration.ActivityBundleQueryInspectoractivityBundleQueryInspectora query inspector
Returnosid.course.registration.ActivityBundleQuerythe activity bundle query
ErrorsNULL_ARGUMENT activityBundleQueryInspector is null
UNSUPPORTED activityBundleQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.