OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AwardSmartAcademySession
Implementsosid.OsidSession
Description

This session manages queries and sequencing to create "smart" dynamic catalogs. An AwardQuery can be retrieved from this session and mapped to this Academy to create a virtual collection of Awards. The awards may be sequenced using the AwardSearchOrder from this session.

This Academy has a default query that matches any award and a default search order that specifies no sequencing. The queries may be examined using an AwardQueryInspector. The query may be modified by converting the inspector back to an AwardQuery.

MethodgetAcademyId
Description

Gets the Academy Id associated with this session.

Returnosid.id.Idthe Academy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetAcademy
Description

Gets the Academy associated with this session.

Returnosid.recognition.Academythe Academy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageSmartAcademies
Description

Tests if this user can manage smart academies. A return of true does not guarantee successful authorization. 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 academy management is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAwardQuery
Description

Gets an award query.

Returnosid.recognition.AwardQuerythe award query
CompliancemandatoryThis method must be implemented.
MethodgetAwardSearchOrder
Description

Gets an award search order.

Returnosid.recognition.AwardSearchOrderthe award search order
CompliancemandatoryThis method must be implemented.
MethodapplyAwardQuery
Description

Applies an award query to this academy.

Parametersosid.recognition.AwardQueryawardQuerythe award query
ErrorsNULL_ARGUMENT awardQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED awardQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectAwardQuery
Description

Gets an award query inspector for this academy.

Returnosid.recognition.AwardQueryInspectorthe award query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyAwardSequencing
Description

Applies an award search order to this academy.

Parametersosid.recognition.AwardSearchOrderawardSearchOrderthe award search order
ErrorsNULL_ARGUMENT awardSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED awardSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAwardQueryFromInspector
Description

Gets an award query from an inspector.

Parametersosid.recognition.AwardQueryInspectorawardQueryInspectora query inspector
Returnosid.recognition.AwardQuerythe award query
ErrorsNULL_ARGUMENT awardQueryInspector is null
UNSUPPORTED awardQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.