OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.AcademySearchSession
Implementsosid.recognition.AcademyQuerySession
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.

getAcademiesByQuery() is the basic search method and returns a list of Academy elements. A more advanced search may be performed with getAcademiesBySearch(). It accepts an AcademySearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getAcademiesBySearch() returns an AcademySearchResults that can be used to access the resulting AcademyList or be used to perform a search within the result set through AcademySearch.

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.

MethodgetAcademySearch
Description

Gets an academy search.

Returnosid.recognition.AcademySearchthe academy search
CompliancemandatoryThis method must be implemented.
MethodgetAcademySearchOrder
Description

Gets an academy search order. The AcademySearchOrder is supplied to an AcademySearch to specify the ordering of results.

Returnosid.recognition.AcademySearchOrderthe academy search order
CompliancemandatoryThis method must be implemented.
MethodgetAcademiesBySearch
Description

Gets the search results matching the given search.

Parametersosid.recognition.AcademyQueryacademyQuerythe academy query
osid.recognition.AcademySearchacademySearchthe academy search
Returnosid.recognition.AcademySearchResultsthe academy search results
ErrorsNULL_ARGUMENT academyQuery or academies earch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED academyQuery or academies earch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetAcademyQueryFromInspector
Description

Gets an academy query from an inspector. The inspector is available from an AcademySearchResults.

Parametersosid.recognition.AcademyQueryInspectoracademyQueryInspectoran academy query inspector
Returnosid.recognition.AcademyQuerythe academy query
ErrorsNULL_ARGUMENT academyQueryInspector is null
UNSUPPORTED academyQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.