org.osid.metering

Interface MeterQuery

All Superinterfaces:

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

public interface MeterQuery
extends OsidObjectQuery

This is the query for searching meters. 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	clearUtilityIdTerms() Clears the utility Id query terms.
void	clearUtilityTerms() Clears the utility query terms.
MeterQueryRecord	getMeterQueryRecord(Type meterRecordType) Gets the meter query record corresponding to the given Meter record Type.
UtilityQuery	getUtilityQuery() Gets the query for a utility.
void	matchUtilityId(Id utilityId, boolean match) Sets the utility Id for this query.
boolean	supportsUtilityQuery() Tests if a UtilityQuery is available.

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

matchUtilityId

void matchUtilityId(Id utilityId,
                  boolean match)

Sets the utility Id for this query.

Parameters:

utilityId - the utility Id

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

Throws:

NullArgumentException - utilityId is null

Compliance:

mandatory - This method must be implemented.

clearUtilityIdTerms

void clearUtilityIdTerms()

Clears the utility Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsUtilityQuery

boolean supportsUtilityQuery()

Tests if a UtilityQuery is available.

Returns:

true if a utility query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getUtilityQuery

UtilityQuery getUtilityQuery()

Gets the query for a utility. Multiple retrievals produce a nested OR term.

Returns:

the utility query

Throws:

UnimplementedException - supportsUtilityQuery() is false

Compliance:

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

clearUtilityTerms

void clearUtilityTerms()

Clears the utility query terms.

Compliance:

mandatory - This method must be implemented.

getMeterQueryRecord

MeterQueryRecord getMeterQueryRecord(Type meterRecordType)
                                     throws OperationFailedException

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

Parameters:

meterRecordType - a meter record type

Returns:

the meter query record

Throws:

NullArgumentException - meterRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(meterRecordType) is false

Compliance:

mandatory - This method must be implemented.