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

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

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

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.

MethodgetConvocationSearch
Description

Gets a convocation search.

Returnosid.recognition.ConvocationSearchthe convocation search
CompliancemandatoryThis method must be implemented.
MethodgetConvocationSearchOrder
Description

Gets a convocation search order. The ConvocationSearchOrder is supplied to a ConvocationSearch to specify the ordering of results.

Returnosid.recognition.ConvocationSearchOrderthe convocation search order interface
CompliancemandatoryThis method must be implemented.
MethodgetConvocationsBySearch
Description

Gets the search results matching the given search.

Parametersosid.recognition.ConvocationQueryconvocationQuerythe convocation query
osid.recognition.ConvocationSearchconvocationSearchthe convocation search
Returnosid.recognition.ConvocationSearchResultsthe convocation search results
ErrorsNULL_ARGUMENT convocationQuery or convocationSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED convocationQuery or convocationSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetConvocationQueryFromInspector
Description

Gets a convocation query from an inspector. The inspector is available from an ConvocationSearchResults.

Parametersosid.recognition.ConvocationQueryInspectorconvocationQueryInspectora convocation query inspector
Returnosid.recognition.ConvocationQuerythe convocation query
ErrorsNULL_ARGUMENT convocationQueryInspector is null
UNSUPPORTED convocationQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.