OSID Logo
OSID Specifications
lexicon package
Version 3.1.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.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByInputPosition
Description

Orders the results by input position.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This 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.TypeparameterRecordType a parameter record type
Returnosid.lexicon.records.ParameterSearchOrderRecord the parameter search order record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(parameterRecordType) is false
Compliancemandatory This method must be implemented.