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

An interface for specifying the ordering of search results.

MethodorderByRule
Description

Specifies a preference for ordering the results by the associated rule. The element of the rule to order is not specified but may be managed through a RuleSearchOrder.

Parametersosid.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENT style is null
CompliancemandatoryThis method must be implemented.
MethodsupportsRuleSearchOrder
Description

Tests if a RuleSearchOrder is available.

Returnboolean true if a rule search order is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRuleSearchOrder
Description

Gets the search order for a rule.

Returnosid.rules.RuleSearchOrderthe rule search order
ErrorsUNIMPLEMENTED supportsRuleSearchOrder() is false
ComplianceoptionalThis method must be implemented if supportsRuleSearchOrder() is true.