OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.TextSearch
Implementsosid.OsidSearch
Used Byosid.lexicon.TextSearchSession
Description

The search interface for governing text searches.

MethodsearchAmongTexts
Description

Execute this search among the given list of texts.

Parametersosid.id.IdListtextIds list of texts
ErrorsNULL_ARGUMENT textIds is null
Compliancemandatory This method must be implemented.
MethodorderTextResults
Description

Specify an ordering to the search results.

Parametersosid.lexicon.TextSearchOrdertextSearchOrder text search order
ErrorsNULL_ARGUMENT textSearchOrder is null
UNSUPPORTED textSearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetTextSearchRecord
Description

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

Parametersosid.type.TypetextSearchRecordType a text search record type
Returnosid.lexicon.records.TextSearchRecord the text search record
ErrorsNULL_ARGUMENT textSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(textSearchRecordType) is false
Compliancemandatory This method must be implemented.