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

This session provides methods for searching Convocation objects. The search query is constructed using the ConvocationQuery. The award record Type also specifies the record for the award query.

Convocations may have a query record indicated by their respective record types. The query record is accessed via the ConvocationQuery. 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.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
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSearchConvocations
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
CompliancemandatoryThis method must be implemented.
MethoduseFederatedAcademyView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedAcademyView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodgetConvocationQuery
Description

Gets a convocation query.

Returnosid.recognition.ConvocationQuerythe convocation query
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsByQuery
Description

Gets a list of convocations matching the given convocation query.

Parametersosid.recognition.ConvocationQueryconvocationQuerythe convocation query
Returnosid.recognition.ConvocationListthe returned ConvocationList
ErrorsNULL_ARGUMENT convocationQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED convocationQuery is not of this service
CompliancemandatoryThis method must be implemented.