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

This session manages queries and sequencing to create "smart" dynamic catalogs. A ConferralQuery can be retrieved from this session and mapped to this Academy to create a virtual collection of Conferrals. The awards may be sequenced using the ConferralSearchOrder from this session.

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

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

Gets a conferral query.

Returnosid.recognition.ConferralQuerythe conferral query
CompliancemandatoryThis method must be implemented.
MethodgetConferralSearchOrder
Description

Gets a conferral search order.

Returnosid.recognition.ConferralSearchOrderthe conferral search order
CompliancemandatoryThis method must be implemented.
MethodapplyConferralQuery
Description

Applies a conferral query to this academy.

Parametersosid.recognition.ConferralQueryconferralQuerythe conferral query
ErrorsNULL_ARGUMENT conferralQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED conferralQuery not of this service
CompliancemandatoryThis method must be implemented.
MethodinspectConferralQuery
Description

Gets a conferral query inspector for this academy.

Returnosid.recognition.ConferralQueryInspectorthe conferral query inspector
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodapplyConferralSequencing
Description

Applies a conferral search order to this academy.

Parametersosid.recognition.ConferralSearchOrderconferralSearchOrderthe conferral search order
ErrorsNULL_ARGUMENT conferralSearchOrder is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED conferralSearchOrder not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConferralQueryFromInspector
Description

Gets a conferral query from an inspector.

Parametersosid.recognition.ConferralQueryInspectorconferralQueryInspectora query inspector
Returnosid.recognition.ConferralQuerythe conferral query
ErrorsNULL_ARGUMENT conferralQueryInspector is null
UNSUPPORTED conferralQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.