OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.TextSearchOrder
Implementsosid.OsidObjectSearchOrder
Used Byosid.lexicon.IdiomSearchOrder
osid.lexicon.TextSearchSession
osid.lexicon.TextSmartPressSession
osid.rules.check.CheckSearchOrder
Description

An interface for specifying the ordering of search results.

MethodgetTextSearchOrderRecord
Description

Gets the text search order record corresponding to the given text record Type . Multiple retrievals return the same underlying object.

Parametersosid.type.TypetextRecordTypea text record type
Returnosid.lexicon.records.TextSearchOrderRecordthe text search order record
ErrorsNULL_ARGUMENTtextRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(textRecordType) is false
CompliancemandatoryThis method must be implemented.