| Interface | osid.OsidRuleApplicatorSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidEnablerSearchOrder | ||
| Implemented By | osid.rules.check.InstructionSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByResource | ||
| Description |
Specifies a preference for ordering the results by the applied resource. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResourceSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a resource search order is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResourceSearchOrder | ||
| Description |
Gets the search order for a resource. | ||
| Return | osid.resource.ResourceSearchOrder | the resource search order | |
| Errors | UNIMPLEMENTED | supportsResourceSearchOrder() is false | |
| Compliance | optional | This method must be implemented if
supportsResourceSearchOrder() is true. | |