OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
metering package
Version 3.0.0
Release Candidate Preview
| Interface | osid.metering.StatisticSearchOrder | ||
|---|---|---|---|
| Implements | osid.OsidCompendiumSearchOrder | ||
| Description |
An interface for specifying the ordering of search results. | ||
| Method | orderByMeter | ||
| Description |
Specified a preference for ordering results by the metered object. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsMeterSearchOrder | ||
| Description |
Tests if a | ||
| Return | boolean | true if a meter search order is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeterSearchOrder | ||
| Description |
Gets the search order for a meter. | ||
| Return | osid.metering.MeterSearchOrder | the meter search order | |
| Errors | UNIMPLEMENTED | supportsMeterSearchOrder() is false | |
| Compliance | optional | This method must be implemented if supportsMeterSearchOrder()
is true. | |
| Method | orderByMeteredObject | ||
| Description |
Specified a preference for ordering results by the metered object. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderBySum | ||
| Description |
Specified a preference for ordering results by the sum. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMean | ||
| Description |
Specified a preference for ordering results by the mean. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMedian | ||
| Description |
Specified a preference for ordering results by the median. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByMode | ||
| Description |
Specified a preference for ordering results by the mode. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByStandardDeviation | ||
| Description |
Specified a preference for ordering results by the standard deviation. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByRMS | ||
| Description |
Specified a preference for ordering results by the root mean square. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByDelta | ||
| Description |
Specified a preference for ordering results by the delta. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByPercentChange | ||
| Description |
Specified a preference for ordering results by the percent change. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderByAverageRate | ||
| Description |
Specified a preference for ordering results by the average rate. | ||
| Parameters | osid.SearchOrderStyle | style | a search order style |
| Errors | NULL_ARGUMENT | style is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStatisticSearchOrderRecord | ||
| Description |
Gets the meter search order record corresponding to the
given statistic record | ||
| Parameters | osid.type.Type | statisticRecordType | a statistic record type |
| Return | osid.metering.records.StatisticSearchOrderRecord | the statistic search order record | |
| Errors | NULL_ARGUMENT | statisticRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(statisticRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |