OSID Specifications
osid package
Version 3.1.0
osid package
Version 3.1.0
| Interface | osid.OsidCompendiumSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidObjectSearchOrder | ||
osid.OsidSubjugateableSearchOrder | |||
| Implemented By | osid.financials.SummarySearchOrder | ||
osid.metering.StatisticSearchOrder | |||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByStartDate | ||
| Description |
Specifies a preference for ordering the result set by the start date. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByEndDate | ||
| Description |
Specifies a preference for ordering the result set by the end date. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByInterpolated | ||
| Description |
Specifies a preference for ordering the result set by interpolated results. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByExtrapolated | ||
| Description |
Specifies a preference for ordering the result set by extrapolated results. | ||
| Parameters | osid.SearchOrderStyle | style | the search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |