OSID Specifications
metering package
Version 3.1.0
metering package
Version 3.1.0
| Interface | osid.metering.StatisticQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCompendiumQueryInspector | ||
| Used By | osid.OsidObjectQueryInspector | ||
osid.metering.StatisticSearchResults | |||
osid.metering.StatisticSmartUtilitySession | |||
| Description |
This is the query inspector for examining meter queries.
Each method specifies an | ||
| Method | getMeterIdTerms | ||
| Description |
Gets the meter | ||
| Return | osid.search.terms.IdTerm[] | the meter Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeterTerms | ||
| Description |
Gets the meter terms. | ||
| Return | osid.metering.MeterQueryInspector[] | the meter terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeteredObjectIdTerms | ||
| Description |
Gets the object | ||
| Return | osid.search.terms.IdTerm[] | the object Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getTimeRangeTerms | ||
| Description |
Gets the time interval term. | ||
| Return | osid.search.terms.DateTimeRangeTerm[] | the time interval | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getSumTerms | ||
| Description |
Gets the sum terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the sum terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumSumTerms | ||
| Description |
Gets the minumim sum terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim sum terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMeanTerms | ||
| Description |
Gets the mean terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the mean terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumMeanTerms | ||
| Description |
Gets the minumim mean terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim mean terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMedianTerms | ||
| Description |
Gets the median terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the median terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumMedianTerms | ||
| Description |
Gets the minumim median terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim median terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getModeTerms | ||
| Description |
Gets the mode terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the mode terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumModeTerms | ||
| Description |
Gets the minumim mode terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim mode terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStandardDeviationTerms | ||
| Description |
Gets the standard deviation terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the standard deviation terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumStandardDeviationTerms | ||
| Description |
Gets the minumim standard deviation terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim standard deviation terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRMSTerms | ||
| Description |
Gets the root mean square terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the root mean square terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumRMSTerms | ||
| Description |
Gets the minumim root mean square terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim root mean square terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDeltaTerms | ||
| Description |
Gets the delta terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the delta terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumDeltaTerms | ||
| Description |
Gets the minumim delta terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim delta terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getPercentChangeTerms | ||
| Description |
Gets the percentage change terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the percentage change terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getMinimumPercentChangeTerms | ||
| Description |
Gets the minimum delta terms. | ||
| Return | osid.search.terms.DecimalTerm[] | the minumim percentage change terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAverageRateTerms | ||
| Description |
Gets the average rate terms. | ||
| Return | osid.search.terms.DecimalRangeTerm[] | the average rate terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStatisticQueryInspectorRecord | ||
| Description |
Gets the statistic query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | statisticRecordType | a statistic record type |
| Return | osid.metering.records.StatisticQueryInspectorRecord | the statistic query inspector 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. | |