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

This session provides methods for searching Academy objects. The search query is constructed using the AcademyQuery. The academy record Type also specifies the record for the academy query.

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

MethodcanSearchAcademies
Description

Tests if this user can perform Academy 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 opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAcademyQuery
Description

Gets an academy query.

Returnosid.recognition.AcademyQuerythe academy query
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesByQuery
Description

Gets a list of Academies matching the given search.

Parametersosid.recognition.AcademyQueryacademyQuerythe academy query
Returnosid.recognition.AcademyListthe returned AcademyList
ErrorsNULL_ARGUMENT academyQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED academyQuery is not of this service
CompliancemandatoryThis method must be implemented.