OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ParameterSearchOrder
Implementsosid.OsidRuleSearchOrder
Used Byosid.configuration.ParameterSearchSession
osid.configuration.ParameterSmartConfigurationSession
osid.configuration.ValueSearchOrder
Description

This interface specifies options for ordering search results.

MethodorderByValueSyntax
Description

Specifies a preference for ordering the results by the value syntax and object type.

Parametersosid.SearchOrderStylestyle a search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodorderByValuesShuffled
Description

Specifies a preference for ordering the results by the shuffle flag.

Parametersosid.SearchOrderStylestyle a 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.configuration.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.