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

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

MethodgetConferrals
Description

Gets the conferral list resulting from a search.

Returnosid.recognition.ConferralListthe conferral list
ErrorsILLEGAL_STATElist has already been retrieved
CompliancemandatoryThis method must be implemented.
MethodgetConferralQueryInspector
Description

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

Returnosid.recognition.ConferralQueryInspectorthe query inspector
CompliancemandatoryThis method must be implemented.
MethodgetConferralSearchResultsRecord
Description

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

Parametersosid.type.TypeconferralSearchRecordTypea conferral search record type
Returnosid.recognition.records.ConferralSearchResultsRecordthe conferral search record
ErrorsNULL_ARGUMENT conferralSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(conferralSearchRecordType) is false
CompliancemandatoryThis method must be implemented.