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

Modifier and Type	Method	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(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the average rate between the given range inclusive.
void	matchDelta(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the delta between the given range inclusive.
void	matchMean(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the mean between the given range inclusive.
void	matchMedian(BigDecimal low, 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(BigDecimal value, boolean match)	Matches statistics with the minimum delta value inclusive.
void	matchMinimumMean(BigDecimal value, boolean match)	Matches statistics with the minimum mean value inclusive.
void	matchMinimumMedian(BigDecimal value, boolean match)	Matches statistics with the minimum median value inclusive.
void	matchMinimumMode(BigDecimal value, boolean match)	Matches statistics with the minimum mode value inclusive.
void	matchMinimumPercentChange(BigDecimal value, boolean match)	Matches statistics with the minimum percentage change value inclusive.
void	matchMinimumRMS(BigDecimal value, boolean match)	Matches statistics with the minimum rms value inclusive.
void	matchMinimumStandardDeviation(BigDecimal value, boolean match)	Matches statistics with the minimum standard deviation value inclusive.
void	matchMinimumSum(BigDecimal value, boolean match)	Matches statistics with the minimum sum value inclusive.
void	matchMode(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the mode between the given range inclusive.
void	matchPercentChange(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the percentage change between the given range inclusive.
void	matchRMS(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the root mean square between the given range inclusive.
void	matchStandardDeviation(BigDecimal low, BigDecimal high, boolean match)	Matches statistics with the standard deviation between the given range inclusive.
void	matchSum(BigDecimal low, 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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidCompendiumQuery

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

Modifier and Type	Method	Description
void	clearEndDateTerms()	Clears the end date query terms.
void	clearExtrapolatedTerms()	Clears the extrapolated query terms.
void	clearInterpolatedTerms()	Clears the interpolated query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches reports with any end date set.
void	matchAnyStartDate(boolean match)	Matches reports with any start date set.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches reports whose effective end date falls in between the given dates inclusive.
void	matchExtrapolated(boolean match)	Match reports that are extrapolated.
void	matchInterpolated(boolean match)	Match reports that are interpolated.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches reports whose start date falls in between the given dates inclusive.

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

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 {@code supportsMeterQuery()} is {@code 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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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(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(BigDecimal low,
 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.