OSID Logo
OSID Specifications
lexicon package
Version 3.0.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.IdiomListthe idiom list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetIdiomQueryInspector
Description

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

Returnosid.lexicon.IdiomQueryInspectorthe idiom query inspector
CompliancemandatoryThis 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.TypeidiomSearchRecordTypean idiom search record type
Returnosid.lexicon.records.IdiomSearchResultsRecordthe idiom search results record
ErrorsNULL_ARGUMENTidiomSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(idiomSearchRecordType) is false
CompliancemandatoryThis method must be implemented.