Interface | osid.metering.StatisticQuery | ||
---|---|---|---|
Implements | osid.OsidCompendiumQuery | ||
Description |
This is the query for searching statistics. Each method
specifies an | ||
Method | matchMeterId | ||
Description |
Sets a meter | ||
Parameters | osid.id.Id | meterId | a meter Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | meterId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeterIdTerms | ||
Description |
Clears the meter | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsMeterQuery | ||
Description |
Tests if a meter query is available. | ||
Return | boolean | true if a meter query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMeterQuery | ||
Description |
Gets the query for a meter. | ||
Return | osid.metering.MeterQuery | the meter query | |
Errors | UNIMPLEMENTED | supportsMeterQuery() is false | |
Compliance | optional | This method must be implemented if supportsMeterQuery() is
true. | |
Method | clearMeterTerms | ||
Description |
Clears the meter query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMeteredObjectId | ||
Description |
Sets an object | ||
Parameters | osid.id.Id | objectId | an object Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeteredObjectIdTerms | ||
Description |
Clears the object query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | setTimeRange | ||
Description |
Sets the time for the statistics to generate. | ||
Parameters | osid.calendaring.DateTime | start | the start time |
osid.calendaring.DateTime | end | the end time | |
Errors | NULL_ARGUMENT | start or end is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchSum | ||
Description |
Matches statistics with the sum between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearSumTerms | ||
Description |
Clears the sum query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumSum | ||
Description |
Matches statistics with the minimum sum value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumSumTerms | ||
Description |
Clears the minimum sum query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMean | ||
Description |
Matches statistics with the mean between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMeanTerms | ||
Description |
Clears the mean query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMean | ||
Description |
Matches statistics with the minimum mean value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumMeanTerms | ||
Description |
Clears the minimum mean query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMedian | ||
Description |
Matches statistics with the median between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMedianTerms | ||
Description |
Clears the median query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMedian | ||
Description |
Matches statistics with the minimum median value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumMedianTerms | ||
Description |
Clears the minimum median query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMode | ||
Description |
Matches statistics with the mode between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearModeTerms | ||
Description |
Clears the mode query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumMode | ||
Description |
Matches statistics with the minimum mode value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumModeTerms | ||
Description |
Clears the minimum mode query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchStandardDeviation | ||
Description |
Matches statistics with the standard deviation between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearStandardDeviationTerms | ||
Description |
Clears the standard deviation query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumStandardDeviation | ||
Description |
Matches statistics with the minimum standard deviation value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumStandardDeviationTerms | ||
Description |
Clears the minimum standard deviation query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRMS | ||
Description |
Matches statistics with the root mean square between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRMSTerms | ||
Description |
Clears the rms query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumRMS | ||
Description |
Matches statistics with the minimum rms value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumRMSTerms | ||
Description |
Clears the minimum rms query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDelta | ||
Description |
Matches statistics with the delta between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearDeltaTerms | ||
Description |
Clears the delta query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumDelta | ||
Description |
Matches statistics with the minimum delta value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumDeltaTerms | ||
Description |
Clears the minimum delta query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchPercentChange | ||
Description |
Matches statistics with the percentage change between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearPercentChangeTerms | ||
Description |
Clears the delta query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchMinimumPercentChange | ||
Description |
Matches statistics with the minimum percentage change value inclusive. | ||
Parameters | decimal | value | the low end of the range |
boolean | match | true for a positive match, false for a
negative match | |
Compliance | mandatory | This method must be implemented. | |
Method | clearMinimumPercentChangeTerms | ||
Description |
Clears the minimum percentage change query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAverageRate | ||
Description |
Matches statistics with the average rate between the given range inclusive. | ||
Parameters | decimal | low | the low end of the range |
decimal | high | the high end of the range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | the low is greater than the high | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAverageRateTerms | ||
Description |
Clears the average rate query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getStatisticQueryRecord | ||
Description |
Gets the statistic query record corresponding to the
given | ||
Parameters | osid.type.Type | statisticRecordType | a statistic record type |
Return | osid.metering.records.StatisticQueryRecord | the statistic query 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. |