OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.ParameterSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.lexicon.ParameterSearchSession
osid.lexicon.ParameterSmartPressSession
Description

An interface for specifying the ordering of search results.

MethodorderBySyntax
Description

Orders the results by syntax.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodorderByInputPosition
Description

Orders the results by input position.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis method must be implemented.
MethodgetParameterSearchOrderRecord
Description

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

Parametersosid.type.TypeparameterRecordTypea parameter record type
Returnosid.lexicon.records.ParameterSearchOrderRecordthe parameter search order record
ErrorsNULL_ARGUMENTparameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(parameterRecordType) is false
CompliancemandatoryThis method must be implemented.