OSID Logo
OSID Specifications
configuration package
Version 3.1.0
Interfaceosid.configuration.ValueSearchOrder
Implementsosid.OsidObjectSearchOrder
osid.OsidOperableSearchOrder
osid.OsidSubjugateableSearchOrder
Used Byosid.configuration.ValueSearchSession
Description

This interface specifies options for ordering search results.

MethodorderByPriority
Description

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

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

Specifies a preference for ordering the results by the value.

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

Tests if a ParameterSearchOrder is available.

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

Gets the parameter search order.

Returnosid.configuration.ParameterSearchOrder the parameter search order
ErrorsUNIMPLEMENTED supportsParameterSearchOrder() is false
Complianceoptional This 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.TypevalueRecordType a value record type
Returnosid.configuration.records.ValueSearchOrderRecord the value search order record
ErrorsNULL_ARGUMENT valueRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(valueRecordType) is false
Compliancemandatory This method must be implemented.