public interface UtilityQuery extends OsidCatalogQuery
This is the query for searching for utilities. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorUtilityIdTerms()
Clears the ancestor utility
Id query terms. |
void |
clearAncestorUtilityTerms()
Clears the ancestor utility query terms.
|
void |
clearDescendantUtilityIdTerms()
Clears the descendant utility
Id query terms. |
void |
clearDescendantUtilityTerms()
Clears the descendant utility query terms.
|
void |
clearMeterIdTerms()
Clears the meter
Id query terms. |
void |
clearMeterTerms()
Clears the meter query terms.
|
UtilityQuery |
getAncestorUtilityQuery()
Gets the query for a utility.
|
UtilityQuery |
getDescendantUtilityQuery()
Gets the query for a utility.
|
MeterQuery |
getMeterQuery()
Gets the query for a meter.
|
UtilityQueryRecord |
getUtilityQueryRecord(Type utilityRecordType)
Gets the utility query record corresponding to the given
Utility record Type. |
void |
matchAncestorUtilityId(Id utilityId,
boolean match)
Sets the utility
Id for this query to match utilities
that have the specified utility as an ancestor. |
void |
matchAnyAncestorUtility(boolean match)
Matches utilities with any ancestor.
|
void |
matchAnyDescendantUtility(boolean match)
Matches utilities with any descendant.
|
void |
matchAnyMeter(boolean match)
Matches utilities with any meter.
|
void |
matchDescendantUtilityId(Id utilityId,
boolean match)
Sets the utility
Id for this query to match utilities
that have the specified utility as a descendant. |
void |
matchMeterId(Id meterId,
boolean match)
Sets a meter
Id. |
boolean |
supportsAncestorUtilityQuery()
Tests if a
UtilityQuery is available. |
boolean |
supportsDescendantUtilityQuery()
Tests if a
UtilityQuery is available. |
boolean |
supportsMeterQuery()
Tests if a meter query is available.
|
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchMeterId(Id meterId, boolean match)
Id.
meterId
- a meter Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- meterId
is
null
mandatory
- This method must be implemented. void clearMeterIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsMeterQuery()
true
if a meter query is available,
false
otherwisemandatory
- This method must be implemented. MeterQuery getMeterQuery()
UnimplementedException
- supportsMeterQuery()
is false
optional
- This method must be implemented if
supportsMeterQuery()
is true.
void matchAnyMeter(boolean match)
match
- true
to match utilities with any meter,
false
to match utilities with no metersmandatory
- This method must be implemented. void clearMeterTerms()
mandatory
- This method must be implemented. void matchAncestorUtilityId(Id utilityId, boolean match)
Id
for this query to match utilities
that have the specified utility as an ancestor.utilityId
- a utility Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- utilityId
is
null
mandatory
- This method must be implemented. void clearAncestorUtilityIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorUtilityQuery()
UtilityQuery
is available. true
if a utility query is available,
false
otherwisemandatory
- This method must be implemented. UtilityQuery getAncestorUtilityQuery()
OR
term.UnimplementedException
-
supportsAncestorUtilityQuery()
is false
optional
- This method must be implemented if
supportsAncestorUtilityQuery()
is true.
void clearAncestorUtilityTerms()
mandatory
- This method must be implemented. void matchAnyAncestorUtility(boolean match)
match
- true
to match utilities with any
ancestor, false
to match root utilitiesmandatory
- This method must be implemented. void matchDescendantUtilityId(Id utilityId, boolean match)
Id
for this query to match utilities
that have the specified utility as a descendant.utilityId
- a utility Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- utilityId
is
null
mandatory
- This method must be implemented. void clearDescendantUtilityIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantUtilityQuery()
UtilityQuery
is available. true
if a utility query is available,
false
otherwisemandatory
- This method must be implemented. UtilityQuery getDescendantUtilityQuery()
OR
term.UnimplementedException
-
supportsDescendantUtilityQuery()
is false
optional
- This method must be implemented if
supportsDescendantUtilityQuery()
is true.
void matchAnyDescendantUtility(boolean match)
match
- true
to match utilities with any
descendant, false
to match leaf utilitiesmandatory
- This method must be implemented. void clearDescendantUtilityTerms()
mandatory
- This method must be implemented. UtilityQueryRecord getUtilityQueryRecord(Type utilityRecordType) throws OperationFailedException
Utility
record Type.
Multiple record retrievals
produce a nested boolean OR
term.utilityRecordType
- a utility record typeNullArgumentException
- utilityRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(utilityRecordType)
is false
mandatory
- This method must be implemented.