OSID Logo
OSID Specifications
recognition package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.ConvocationSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetConvocations
Description

Gets the convocation list resulting from a search.

Returnosid.recognition.ConvocationListthe convocation list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetConvocationQueryInspector
Description

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

Returnosid.recognition.ConvocationQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypeconvocationSearchRecordTypea convocation search record type
Returnosid.recognition.records.ConvocationSearchResultsRecordthe convocation search record
ErrorsNULL_ARGUMENT convocationSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(convocationSearchRecordType) is false
CompliancemandatoryThis method must be implemented.