OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConferralQuerySession
Implementsosid.OsidSession
Implemented Byosid.recognition.ConferralSearchSession
Used Byosid.recognition.RecognitionManager
osid.recognition.RecognitionProxyManager
Description

This session provides methods for searching Conferrals. The search query is constructed using the ConferralQuery. The conferral record Type also specifies the record for the award query.

Conferrals may have a query record indicated by their respective record types. The query record is accessed via the ConferralQuery. The returns in this session may not be cast directly to these interfaces.

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
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSearchConferrals
Description

Tests if this user can perform susbcription searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseFederatedAcademyView
Description

Federates the view for methods in this session. A federated view will include conferrals in academies which are children of this academy in the academy hierarchy.

Compliancemandatory This method is must be implemented.
MethoduseIsolatedAcademyView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this academy only.

Compliancemandatory This method is must be implemented.
MethodgetConferralQuery
Description

Gets a conferral query.

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

Gets a list of conferrals matching the given conferral query.

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