Interface | osid.OsidRuleSearchOrder | ||
---|---|---|---|
Implements | osid.OsidObjectSearchOrder | ||
osid.OsidOperableSearchOrder | |||
Description |
An interface for specifying the ordering of search results. | ||
Method | orderByRule | ||
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 | ||
Parameters | osid.SearchOrderStyle | style | search order style |
Errors | NULL_ARGUMENT | style is null | |
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuleSearchOrder | ||
Description |
Tests if a | ||
Return | boolean | true if a rule search order is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuleSearchOrder | ||
Description |
Gets the search order for a rule. | ||
Return | osid.rules.RuleSearchOrder | the rule search order | |
Errors | UNIMPLEMENTED | supportsRuleSearchOrder() is false | |
Compliance | optional | This method must be implemented if supportsRuleSearchOrder()
is true. |