OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.StatisticQuery
Implementsosid.OsidCompendiumQuery
Description

This is the query for searching statistics. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchMeterId
Description

Sets a meter Id.

Parametersosid.id.IdmeterIda meter Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT meterId is null
CompliancemandatoryThis method must be implemented.
MethodclearMeterIdTerms
Description

Clears the meter Id query term.

CompliancemandatoryThis method must be implemented.
MethodsupportsMeterQuery
Description

Tests if a meter query is available.

Returnboolean true if a meter query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetMeterQuery
Description

Gets the query for a meter.

Returnosid.metering.MeterQuerythe meter query
ErrorsUNIMPLEMENTED supportsMeterQuery() is false
ComplianceoptionalThis method must be implemented if supportsMeterQuery() is true.
MethodclearMeterTerms
Description

Clears the meter query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMeteredObjectId
Description

Sets an object Id.

Parametersosid.id.IdobjectIdan object Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT objectId is null
CompliancemandatoryThis method must be implemented.
MethodclearMeteredObjectIdTerms
Description

Clears the object query terms.

CompliancemandatoryThis method must be implemented.
MethodsetTimeRange
Description

Sets the time for the statistics to generate.

Parametersosid.calendaring.DateTimestartthe start time
osid.calendaring.DateTimeendthe end time
ErrorsNULL_ARGUMENT start or end is null
CompliancemandatoryThis method must be implemented.
MethodmatchSum
Description

Matches statistics with the sum between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearSumTerms
Description

Clears the sum query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumSum
Description

Matches statistics with the minimum sum value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumSumTerms
Description

Clears the minimum sum query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMean
Description

Matches statistics with the mean between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearMeanTerms
Description

Clears the mean query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMean
Description

Matches statistics with the minimum mean value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumMeanTerms
Description

Clears the minimum mean query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMedian
Description

Matches statistics with the median between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearMedianTerms
Description

Clears the median query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMedian
Description

Matches statistics with the minimum median value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumMedianTerms
Description

Clears the minimum median query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMode
Description

Matches statistics with the mode between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearModeTerms
Description

Clears the mode query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumMode
Description

Matches statistics with the minimum mode value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumModeTerms
Description

Clears the minimum mode query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchStandardDeviation
Description

Matches statistics with the standard deviation between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearStandardDeviationTerms
Description

Clears the standard deviation query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumStandardDeviation
Description

Matches statistics with the minimum standard deviation value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumStandardDeviationTerms
Description

Clears the minimum standard deviation query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRMS
Description

Matches statistics with the root mean square between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearRMSTerms
Description

Clears the rms query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumRMS
Description

Matches statistics with the minimum rms value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumRMSTerms
Description

Clears the minimum rms query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDelta
Description

Matches statistics with the delta between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearDeltaTerms
Description

Clears the delta query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumDelta
Description

Matches statistics with the minimum delta value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumDeltaTerms
Description

Clears the minimum delta query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchPercentChange
Description

Matches statistics with the percentage change between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearPercentChangeTerms
Description

Clears the delta query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchMinimumPercentChange
Description

Matches statistics with the minimum percentage change value inclusive.

Parametersdecimalvaluethe low end of the range
booleanmatch true for a positive match, false for a negative match
CompliancemandatoryThis method must be implemented.
MethodclearMinimumPercentChangeTerms
Description

Clears the minimum percentage change query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAverageRate
Description

Matches statistics with the average rate between the given range inclusive.

Parametersdecimallowthe low end of the range
decimalhighthe high end of the range
booleanmatch true for a positive match, false for a negative match
ErrorsINVALID_ARGUMENTthe low is greater than the high
CompliancemandatoryThis method must be implemented.
MethodclearAverageRateTerms
Description

Clears the average rate query terms.

CompliancemandatoryThis method must be implemented.
MethodgetStatisticQueryRecord
Description

Gets the statistic query record corresponding to the given Statistic record Type. Multiple retrievals produce a nested OR term.

Parametersosid.type.TypestatisticRecordTypea statistic record type
Returnosid.metering.records.StatisticQueryRecordthe statistic query record
ErrorsNULL_ARGUMENT statisticRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(statisticRecordType) is false
CompliancemandatoryThis method must be implemented.