OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.IdiomSearch
Implementsosid.OsidSearch
Used Byosid.lexicon.IdiomSearchSession
Description

The search interface for governing idiom searches.

MethodsearchAmongIdioms
Description

Execute this search among the given list of idioms.

Parametersosid.id.IdListidiomIds list of idioms
ErrorsNULL_ARGUMENT idiomIds is null
Compliancemandatory This method must be implemented.
MethodorderIdiomResults
Description

Specify an ordering to the search results.

Parametersosid.lexicon.IdiomSearchOrderidiomSearchOrder idiom search order
ErrorsNULL_ARGUMENT idiomSearchOrder is null
UNSUPPORTED idiomSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetIdiomSearchRecord
Description

Gets the idiom search 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.IdiomSearchRecord the idiom search record
ErrorsNULL_ARGUMENT idiomSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(idiomSearchRecordType) is false
Compliancemandatory This method must be implemented.