OSID Logo
OSID Specifications
lexicon package
Version 3.0.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.IdListidiomIdslist of idioms
ErrorsNULL_ARGUMENTidiomIds is null
CompliancemandatoryThis method must be implemented.
MethodorderIdiomResults
Description

Specify an ordering to the search results.

Parametersosid.lexicon.IdiomSearchOrderidiomSearchOrderidiom search order
ErrorsNULL_ARGUMENTidiomSearchOrder is null
UNSUPPORTEDidiomSearchOrder is not of this service
CompliancemandatoryThis 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.TypeidiomSearchRecordTypean idiom search record type
Returnosid.lexicon.records.IdiomSearchRecordthe idiom search record
ErrorsNULL_ARGUMENTidiomSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(idiomSearchRecordType) is false
CompliancemandatoryThis method must be implemented.