OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.IdiomSearchResults
Implementsosid.OsidSearchResults
Used Byosid.lexicon.IdiomSearchSession
Description

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

MethodgetIdioms
Description

Gets the idiom list resulting from a search.

Returnosid.lexicon.IdiomList the idiom list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetIdiomQueryInspector
Description

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

Returnosid.lexicon.IdiomQueryInspector the idiom query inspector
Compliancemandatory This method must be implemented.
MethodgetIdiomSearchResultsRecord
Description

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

Parametersosid.type.TypeidiomSearchRecordType an idiom search record type
Returnosid.lexicon.records.IdiomSearchResultsRecord the idiom search results record
ErrorsNULL_ARGUMENT idiomSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(idiomSearchRecordType) is false
Compliancemandatory This method must be implemented.