org.osid.metering

Interface StatisticQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCompendiumQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface StatisticQueryInspector
extends OsidCompendiumQueryInspector

This is the query inspector for examining meter queries. Each method specifies an AND term while multiple terms of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
DecimalRangeTerm[]	getAverageRateTerms() Gets the average rate terms.
DecimalRangeTerm[]	getDeltaTerms() Gets the delta terms.
DecimalRangeTerm[]	getMeanTerms() Gets the mean terms.
DecimalRangeTerm[]	getMedianTerms() Gets the median terms.
IdTerm[]	getMeteredObjectIdTerms() Gets the object Id terms.
IdTerm[]	getMeterIdTerms() Gets the meter Id terms.
MeterQueryInspector[]	getMeterTerms() Gets the meter terms.
DecimalTerm[]	getMinimumDeltaTerms() Gets the minumim delta terms.
DecimalTerm[]	getMinimumMeanTerms() Gets the minumim mean terms.
DecimalTerm[]	getMinimumMedianTerms() Gets the minumim median terms.
DecimalTerm[]	getMinimumModeTerms() Gets the minumim mode terms.
DecimalTerm[]	getMinimumPercentChangeTerms() Gets the minimum delta terms.
DecimalTerm[]	getMinimumRMSTerms() Gets the minumim root mean square terms.
DecimalTerm[]	getMinimumStandardDeviationTerms() Gets the minumim standard deviation terms.
DecimalTerm[]	getMinimumSumTerms() Gets the minumim sum terms.
DecimalRangeTerm[]	getModeTerms() Gets the mode terms.
DecimalRangeTerm[]	getPercentChangeTerms() Gets the percentage change terms.
DecimalRangeTerm[]	getRMSTerms() Gets the root mean square terms.
DecimalRangeTerm[]	getStandardDeviationTerms() Gets the standard deviation terms.
StatisticQueryInspectorRecord	getStatisticQueryInspectorRecord(Type statisticRecordType) Gets the statistic query inspector record corresponding to the given Statistic record Type.
DecimalRangeTerm[]	getSumTerms() Gets the sum terms.
DateTimeRangeTerm[]	getTimeRangeTerms() Gets the time interval term.

Methods inherited from interface org.osid.OsidCompendiumQueryInspector

getEndDateTerms, getExtrapolatedTerms, getInterpolatedTerms, getStartDateTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getMeterIdTerms

IdTerm[] getMeterIdTerms()

Gets the meter Id terms.

Returns:

the meter Id terms

Compliance:

mandatory - This method must be implemented.

getMeterTerms

MeterQueryInspector[] getMeterTerms()

Gets the meter terms.

Returns:

the meter terms

Compliance:

mandatory - This method must be implemented.

getMeteredObjectIdTerms

IdTerm[] getMeteredObjectIdTerms()

Gets the object Id terms.

Returns:

the object Id terms

Compliance:

mandatory - This method must be implemented.

getTimeRangeTerms

DateTimeRangeTerm[] getTimeRangeTerms()

Gets the time interval term.

Returns:

the time interval

Compliance:

mandatory - This method must be implemented.

getSumTerms

DecimalRangeTerm[] getSumTerms()

Gets the sum terms.

Returns:

the sum terms

Compliance:

mandatory - This method must be implemented.

getMinimumSumTerms

DecimalTerm[] getMinimumSumTerms()

Gets the minumim sum terms.

Returns:

the minumim sum terms

Compliance:

mandatory - This method must be implemented.

getMeanTerms

DecimalRangeTerm[] getMeanTerms()

Gets the mean terms.

Returns:

the mean terms

Compliance:

mandatory - This method must be implemented.

getMinimumMeanTerms

DecimalTerm[] getMinimumMeanTerms()

Gets the minumim mean terms.

Returns:

the minumim mean terms

Compliance:

mandatory - This method must be implemented.

getMedianTerms

DecimalRangeTerm[] getMedianTerms()

Gets the median terms.

Returns:

the median terms

Compliance:

mandatory - This method must be implemented.

getMinimumMedianTerms

DecimalTerm[] getMinimumMedianTerms()

Gets the minumim median terms.

Returns:

the minumim median terms

Compliance:

mandatory - This method must be implemented.

getModeTerms

DecimalRangeTerm[] getModeTerms()

Gets the mode terms.

Returns:

the mode terms

Compliance:

mandatory - This method must be implemented.

getMinimumModeTerms

DecimalTerm[] getMinimumModeTerms()

Gets the minumim mode terms.

Returns:

the minumim mode terms

Compliance:

mandatory - This method must be implemented.

getStandardDeviationTerms

DecimalRangeTerm[] getStandardDeviationTerms()

Gets the standard deviation terms.

Returns:

the standard deviation terms

Compliance:

mandatory - This method must be implemented.

getMinimumStandardDeviationTerms

DecimalTerm[] getMinimumStandardDeviationTerms()

Gets the minumim standard deviation terms.

Returns:

the minumim standard deviation terms

Compliance:

mandatory - This method must be implemented.

getRMSTerms

DecimalRangeTerm[] getRMSTerms()

Gets the root mean square terms.

Returns:

the root mean square terms

Compliance:

mandatory - This method must be implemented.

getMinimumRMSTerms

DecimalTerm[] getMinimumRMSTerms()

Gets the minumim root mean square terms.

Returns:

the minumim root mean square terms

Compliance:

mandatory - This method must be implemented.

getDeltaTerms

DecimalRangeTerm[] getDeltaTerms()

Gets the delta terms.

Returns:

the delta terms

Compliance:

mandatory - This method must be implemented.

getMinimumDeltaTerms

DecimalTerm[] getMinimumDeltaTerms()

Gets the minumim delta terms.

Returns:

the minumim delta terms

Compliance:

mandatory - This method must be implemented.

getPercentChangeTerms

DecimalRangeTerm[] getPercentChangeTerms()

Gets the percentage change terms.

Returns:

the percentage change terms

Compliance:

mandatory - This method must be implemented.

getMinimumPercentChangeTerms

DecimalTerm[] getMinimumPercentChangeTerms()

Gets the minimum delta terms.

Returns:

the minumim percentage change terms

Compliance:

mandatory - This method must be implemented.

getAverageRateTerms

DecimalRangeTerm[] getAverageRateTerms()

Gets the average rate terms.

Returns:

the average rate terms

Compliance:

mandatory - This method must be implemented.

getStatisticQueryInspectorRecord

StatisticQueryInspectorRecord getStatisticQueryInspectorRecord(Type statisticRecordType)
                                                               throws OperationFailedException

Gets the statistic query inspector 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 inspector record

Throws:

NullArgumentException - statisticRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(statisticRecordType) is false

Compliance:

mandatory - This method must be implemented.