OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ValueSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
osid.OsidSubjugateableSearchOrder
Description

This interface specifies options for ordering search results.

MethodorderByPriority
Description

Specifies a preference for ordering the results by the value priority.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodorderByValue
Description

Specifies a preference for ordering the results by the value.

Parametersosid.SearchOrderStylestylea search order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsParameterSearchOrder
Description

Tests if a ParameterSearchOrder is available.

Returnboolean true if a parameter search order interface is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetParameterSearchOrder
Description

Gets the parameter search order.

Returnosid.configuration.ParameterSearchOrderthe parameter search order
ErrorsUNIMPLEMENTED supportsParameterSearchOrder() is false
ComplianceoptionalThis method must be implemented is supportsParameterSearchOrder() is true.
MethodgetValueSearchOrderRecord
Description

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

Parametersosid.type.TypevalueRecordTypea value record type
Returnosid.configuration.records.ValueSearchOrderRecordthe value search order record
ErrorsNULL_ARGUMENT valueRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(valueRecordType) is false
CompliancemandatoryThis method must be implemented.