OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConferralSmartAcademySession
Implementsosid.OsidSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
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.Id the Academy Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetAcademy
Description

Gets the Academy associated with this session.

Returnosid.recognition.Academy the Academy associated with this session
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This 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
Compliancemandatory This method must be implemented.
MethodgetConferralQuery
Description

Gets a conferral query.

Returnosid.recognition.ConferralQuery the conferral query
Compliancemandatory This method must be implemented.
MethodgetConferralSearchOrder
Description

Gets a conferral search order.

Returnosid.recognition.ConferralSearchOrder the conferral search order
Compliancemandatory This method must be implemented.
MethodapplyConferralQuery
Description

Applies a conferral query to this academy.

Parametersosid.recognition.ConferralQueryconferralQuery the conferral query
ErrorsNULL_ARGUMENT conferralQuery is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED conferralQuery not of this service
Compliancemandatory This method must be implemented.
MethodinspectConferralQuery
Description

Gets a conferral query inspector for this academy.

Returnosid.recognition.ConferralQueryInspector the conferral query inspector
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
Compliancemandatory This method must be implemented.
MethodapplyConferralSequencing
Description

Applies a conferral search order to this academy.

Parametersosid.recognition.ConferralSearchOrderconferralSearchOrder the conferral search order
ErrorsNULL_ARGUMENT conferralSearchOrder is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure occurred
UNSUPPORTED conferralSearchOrder not of this service
Compliancemandatory This method must be implemented.
MethodgetConferralQueryFromInspector
Description

Gets a conferral query from an inspector.

Parametersosid.recognition.ConferralQueryInspectorconferralQueryInspector a query inspector
Returnosid.recognition.ConferralQuery the conferral query
ErrorsNULL_ARGUMENT conferralQueryInspector is null
UNSUPPORTED conferralQueryInspector is not of this service
Compliancemandatory This method must be implemented.