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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AwardEntryQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of AwardEntries. The courses may be sequenced using the AwardEntrySearchOrder 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 an AwardEntryQueryInspector. The query may be modified by converting the inspector back to an AwardEntryQuery.

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 award. 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.
MethodgetAwardEntryQuery
Description

Gets an award entry query.

Returnosid.course.chronicle.AwardEntryQuerythe award entry query
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntrySearchOrder
Description

Gets an award entry search order.

Returnosid.course.chronicle.AwardEntrySearchOrderthe award entry search order
CompliancemandatoryThis method must be implemented.
MethodapplyAwardEntryQuery
Description

Applies an award entry query to this course catalog.

Parametersosid.course.chronicle.AwardEntryQueryawardEntryQuerythe award entry query
ErrorsNULL_ARGUMENT awardEntryQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED awardEntryQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAwardEntryQuery
Description

Gets an award entry query inspector for this course catalog.

Returnosid.course.chronicle.AwardEntryQueryInspectorthe award entry query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAwardEntrySequencing
Description

Applies an award entry search order to this course catalog.

Parametersosid.course.chronicle.AwardEntrySearchOrderawardEntrySearchOrderthe award entry search order
ErrorsNULL_ARGUMENT awardEntrySearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED awardEntrySearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryQueryFromInspector
Description

Gets an award entry query from an inspector.

Parametersosid.course.chronicle.AwardEntryQueryInspectorawardEntryQueryInspectora query inspector
Returnosid.course.chronicle.AwardEntryQuerythe award entry query
ErrorsNULL_ARGUMENT awardEntryQueryInspector is null
UNSUPPORTED awardEntryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.