org.osid.metering

Interface StatisticQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCompendiumQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSubjugateableQuery, Suppliable

public interface StatisticQuery
extends OsidCompendiumQuery

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAverageRateTerms() Clears the average rate query terms.
void	clearDeltaTerms() Clears the delta query terms.
void	clearMeanTerms() Clears the mean query terms.
void	clearMedianTerms() Clears the median query terms.
void	clearMeteredObjectIdTerms() Clears the object query terms.
void	clearMeterIdTerms() Clears the meter Id query term.
void	clearMeterTerms() Clears the meter query terms.
void	clearMinimumDeltaTerms() Clears the minimum delta query terms.
void	clearMinimumMeanTerms() Clears the minimum mean query terms.
void	clearMinimumMedianTerms() Clears the minimum median query terms.
void	clearMinimumModeTerms() Clears the minimum mode query terms.
void	clearMinimumPercentChangeTerms() Clears the minimum percentage change query terms.
void	clearMinimumRMSTerms() Clears the minimum rms query terms.
void	clearMinimumStandardDeviationTerms() Clears the minimum standard deviation query terms.
void	clearMinimumSumTerms() Clears the minimum sum query terms.
void	clearModeTerms() Clears the mode query terms.
void	clearPercentChangeTerms() Clears the delta query terms.
void	clearRMSTerms() Clears the rms query terms.
void	clearStandardDeviationTerms() Clears the standard deviation query terms.
void	clearSumTerms() Clears the sum query terms.
MeterQuery	getMeterQuery() Gets the query for a meter.
StatisticQueryRecord	getStatisticQueryRecord(Type statisticRecordType) Gets the statistic query record corresponding to the given Statistic record Type.
void	matchAverageRate(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the average rate between the given range inclusive.
void	matchDelta(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the delta between the given range inclusive.
void	matchMean(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the mean between the given range inclusive.
void	matchMedian(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the median between the given range inclusive.
void	matchMeteredObjectId(Id objectId, boolean match) Sets an object Id.
void	matchMeterId(Id meterId, boolean match) Sets a meter Id.
void	matchMinimumDelta(java.math.BigDecimal value, boolean match) Matches statistics with the minimum delta value inclusive.
void	matchMinimumMean(java.math.BigDecimal value, boolean match) Matches statistics with the minimum mean value inclusive.
void	matchMinimumMedian(java.math.BigDecimal value, boolean match) Matches statistics with the minimum median value inclusive.
void	matchMinimumMode(java.math.BigDecimal value, boolean match) Matches statistics with the minimum mode value inclusive.
void	matchMinimumPercentChange(java.math.BigDecimal value, boolean match) Matches statistics with the minimum percentage change value inclusive.
void	matchMinimumRMS(java.math.BigDecimal value, boolean match) Matches statistics with the minimum rms value inclusive.
void	matchMinimumStandardDeviation(java.math.BigDecimal value, boolean match) Matches statistics with the minimum standard deviation value inclusive.
void	matchMinimumSum(java.math.BigDecimal value, boolean match) Matches statistics with the minimum sum value inclusive.
void	matchMode(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the mode between the given range inclusive.
void	matchPercentChange(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the percentage change between the given range inclusive.
void	matchRMS(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the root mean square between the given range inclusive.
void	matchStandardDeviation(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the standard deviation between the given range inclusive.
void	matchSum(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches statistics with the sum between the given range inclusive.
void	setTimeRange(DateTime start, DateTime end) Sets the time for the statistics to generate.
boolean	supportsMeterQuery() Tests if a meter query is available.

Methods inherited from interface org.osid.OsidCompendiumQuery

clearEndDateTerms, clearExtrapolatedTerms, clearInterpolatedTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchEndDate, matchExtrapolated, matchInterpolated, matchStartDate

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Method Detail

matchMeterId

void matchMeterId(Id meterId,
                boolean match)

Sets a meter Id.

Parameters:

meterId - a meter Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - meterId is null

Compliance:

mandatory - This method must be implemented.

clearMeterIdTerms

void clearMeterIdTerms()

Clears the meter Id query term.

Compliance:

mandatory - This method must be implemented.

supportsMeterQuery

boolean supportsMeterQuery()

Tests if a meter query is available.

Returns:

true if a meter query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getMeterQuery

MeterQuery getMeterQuery()

Gets the query for a meter.

Returns:

the meter query

Throws:

UnimplementedException - supportsMeterQuery() is false

Compliance:

optional - This method must be implemented if supportsMeterQuery() is true.

clearMeterTerms

void clearMeterTerms()

Clears the meter query terms.

Compliance:

mandatory - This method must be implemented.

matchMeteredObjectId

void matchMeteredObjectId(Id objectId,
                        boolean match)

Sets an object Id.

Parameters:

objectId - an object Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - objectId is null

Compliance:

mandatory - This method must be implemented.

clearMeteredObjectIdTerms

void clearMeteredObjectIdTerms()

Clears the object query terms.

Compliance:

mandatory - This method must be implemented.

setTimeRange

void setTimeRange(DateTime start,
                DateTime end)

Sets the time for the statistics to generate.

Parameters:

start - the start time

end - the end time

Throws:

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchSum

void matchSum(java.math.BigDecimal low,
            java.math.BigDecimal high,
            boolean match)

Matches statistics with the sum between the given range inclusive.

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearSumTerms

void clearSumTerms()

Clears the sum query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumSum

void matchMinimumSum(java.math.BigDecimal value,
                   boolean match)

Matches statistics with the minimum sum value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumSumTerms

void clearMinimumSumTerms()

Clears the minimum sum query terms.

Compliance:

mandatory - This method must be implemented.

matchMean

void matchMean(java.math.BigDecimal low,
             java.math.BigDecimal high,
             boolean match)

Matches statistics with the mean between the given range inclusive.

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearMeanTerms

void clearMeanTerms()

Clears the mean query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMean

void matchMinimumMean(java.math.BigDecimal value,
                    boolean match)

Matches statistics with the minimum mean value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumMeanTerms

void clearMinimumMeanTerms()

Clears the minimum mean query terms.

Compliance:

mandatory - This method must be implemented.

matchMedian

void matchMedian(java.math.BigDecimal low,
               java.math.BigDecimal high,
               boolean match)

Matches statistics with the median between the given range inclusive.

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearMedianTerms

void clearMedianTerms()

Clears the median query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMedian

void matchMinimumMedian(java.math.BigDecimal value,
                      boolean match)

Matches statistics with the minimum median value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumMedianTerms

void clearMinimumMedianTerms()

Clears the minimum median query terms.

Compliance:

mandatory - This method must be implemented.

matchMode

void matchMode(java.math.BigDecimal low,
             java.math.BigDecimal high,
             boolean match)

Matches statistics with the mode between the given range inclusive.

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearModeTerms

void clearModeTerms()

Clears the mode query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumMode

void matchMinimumMode(java.math.BigDecimal value,
                    boolean match)

Matches statistics with the minimum mode value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumModeTerms

void clearMinimumModeTerms()

Clears the minimum mode query terms.

Compliance:

mandatory - This method must be implemented.

matchStandardDeviation

void matchStandardDeviation(java.math.BigDecimal low,
                          java.math.BigDecimal high,
                          boolean match)

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

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearStandardDeviationTerms

void clearStandardDeviationTerms()

Clears the standard deviation query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumStandardDeviation

void matchMinimumStandardDeviation(java.math.BigDecimal value,
                                 boolean match)

Matches statistics with the minimum standard deviation value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumStandardDeviationTerms

void clearMinimumStandardDeviationTerms()

Clears the minimum standard deviation query terms.

Compliance:

mandatory - This method must be implemented.

matchRMS

void matchRMS(java.math.BigDecimal low,
            java.math.BigDecimal high,
            boolean match)

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

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearRMSTerms

void clearRMSTerms()

Clears the rms query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumRMS

void matchMinimumRMS(java.math.BigDecimal value,
                   boolean match)

Matches statistics with the minimum rms value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumRMSTerms

void clearMinimumRMSTerms()

Clears the minimum rms query terms.

Compliance:

mandatory - This method must be implemented.

matchDelta

void matchDelta(java.math.BigDecimal low,
              java.math.BigDecimal high,
              boolean match)

Matches statistics with the delta between the given range inclusive.

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearDeltaTerms

void clearDeltaTerms()

Clears the delta query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumDelta

void matchMinimumDelta(java.math.BigDecimal value,
                     boolean match)

Matches statistics with the minimum delta value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumDeltaTerms

void clearMinimumDeltaTerms()

Clears the minimum delta query terms.

Compliance:

mandatory - This method must be implemented.

matchPercentChange

void matchPercentChange(java.math.BigDecimal low,
                      java.math.BigDecimal high,
                      boolean match)

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

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearPercentChangeTerms

void clearPercentChangeTerms()

Clears the delta query terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumPercentChange

void matchMinimumPercentChange(java.math.BigDecimal value,
                             boolean match)

Matches statistics with the minimum percentage change value inclusive.

Parameters:

value - the low end of the range

match - true for a positive match, false for a negative match

Compliance:

mandatory - This method must be implemented.

clearMinimumPercentChangeTerms

void clearMinimumPercentChangeTerms()

Clears the minimum percentage change query terms.

Compliance:

mandatory - This method must be implemented.

matchAverageRate

void matchAverageRate(java.math.BigDecimal low,
                    java.math.BigDecimal high,
                    boolean match)

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

Parameters:

low - the low end of the range

high - the high end of the range

match - true for a positive match, false for a negative match

Throws:

InvalidArgumentException - the low is greater than the high

Compliance:

mandatory - This method must be implemented.

clearAverageRateTerms

void clearAverageRateTerms()

Clears the average rate query terms.

Compliance:

mandatory - This method must be implemented.

getStatisticQueryRecord

StatisticQueryRecord getStatisticQueryRecord(Type statisticRecordType)
                                             throws OperationFailedException

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

Parameters:

statisticRecordType - a statistic record type

Returns:

the statistic query record

Throws:

NullArgumentException - statisticRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(statisticRecordType) is false

Compliance:

mandatory - This method must be implemented.