OSID Specifications
osid package
Version 3.0.0
Release Candidate Preview
osid package
Version 3.0.0
Release Candidate Preview
| Interface | osid.OsidSourceableSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByProvider | ||
| Description |
Specifies a preference for ordering the results by provider. The element of the provider to order is not specified but may be managed through the provider ordering interface. | ||
| Parameters | osid.SearchOrderStyle | style | search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsProviderSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a provider search order interface is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProviderSearchOrder | ||
| Description |
Gets the search order interface for a provider. | ||
| Return | osid.resource.ResourceSearchOrder | the provider search order interface | |
| Errors | UNIMPLEMENTED | supportsProviderSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsProviderSearchOrder()
is true. | |