OSID Logo
OSID Specifications
recognition package
Version 3.1.0
Interfaceosid.recognition.ConvocationSearchResults
Implementsosid.OsidSearchResults
Used Byosid.recognition.ConvocationSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetConvocations
Description

Gets the convocation list resulting from a search.

Returnosid.recognition.ConvocationList the convocation list
ErrorsILLEGAL_STATE list has already been retrieved
Compliancemandatory This method must be implemented.
MethodgetConvocationQueryInspector
Description

Gets the inspector for the query to examine the terns used in the search.

Returnosid.recognition.ConvocationQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetConvocationSearchResultsRecord
Description

Gets the convocation search results record corresponding to the given convocation search record Type.This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypeconvocationSearchRecordType a convocation search record type
Returnosid.recognition.records.ConvocationSearchResultsRecord the convocation search record
ErrorsNULL_ARGUMENT convocationSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(convocationSearchRecordType) is false
Compliancemandatory This method must be implemented.