OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ParameterSearchOrder
Implementsosid.OsidRuleSearchOrder
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.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByValuesShuffled
Description

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

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style 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.configuration.records.ParameterSearchOrderRecordthe parameter search order record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterRecordType) is false
CompliancemandatoryThis method must be implemented.