OSID Logo
OSID Specifications
lexicon package
Version 3.0.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.IdListtextIdslist of texts
ErrorsNULL_ARGUMENTtextIds is null
CompliancemandatoryThis method must be implemented.
MethodorderTextResults
Description

Specify an ordering to the search results.

Parametersosid.lexicon.TextSearchOrdertextSearchOrdertext search order
ErrorsNULL_ARGUMENTtextSearchOrder is null
UNSUPPORTEDtextSearchOrder is not of this service
CompliancemandatoryThis 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.TypetextSearchRecordTypea text search record type
Returnosid.lexicon.records.TextSearchRecordthe text search record
ErrorsNULL_ARGUMENTtextSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(textSearchRecordType) is false
CompliancemandatoryThis method must be implemented.