public interface BillingQuery extends OsidCatalogQuery
This is the query for searching for billings. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorBillingIdTerms()
Clears all ancestor billing
Id terms. |
void |
clearAncestorBillingTerms()
Clears all ancestor billing terms.
|
void |
clearCreditIdTerms()
Clears all credit
Id terms. |
void |
clearCreditTerms()
Clears all credit terms.
|
void |
clearDescendantBillingIdTerms()
Clears all descendant billing
Id terms. |
void |
clearDescendantBillingTerms()
Clears all descendant billing terms.
|
BillingQuery |
getAncestorBillingQuery()
Gets the query for a billing.
|
BillingQueryRecord |
getBillingQueryRecord(Type billingRecordType)
Gets the record query corresponding to the given
Billing
record Type. |
CreditQuery |
getCreditQuery()
Gets the query for a billing.
|
BillingQuery |
getDescendantBillingQuery()
Gets the query for a billing.
|
void |
matchAncestorBillingId(Id billingId,
boolean match)
Sets the billing
Id for this query to match billings
that have the specified billing as an ancestor. |
void |
matchAnyAncestorBilling(boolean match)
Matches billings with any ancestor.
|
void |
matchAnyCredit(boolean match)
Matches billings with any credit.
|
void |
matchAnyDescendantBilling(boolean match)
Matches billings with any descendant.
|
void |
matchCreditId(Id creditId,
boolean match)
Sets the credit
Id for this query to match credits
assigned to billings. |
void |
matchDescendantBillingId(Id billingId,
boolean match)
Sets the billing
Id for this query to match billings
that have the specified billing as a descendant. |
boolean |
supportsAncestorBillingQuery()
Tests if a
BillingQuery is available. |
boolean |
supportsCreditQuery()
Tests if a credit query is available.
|
boolean |
supportsDescendantBillingQuery()
Tests if a
BillingQuery is available. |
clearCommentIdTerms, clearCommentTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, 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 matchCreditId(Id creditId, boolean match)
Id
for this query to match credits
assigned to billings.matchCreditId
in interface OsidObjectQuery
creditId
- a credit Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- creditId
is
null
mandatory
- This method must be implemented. void clearCreditIdTerms()
Id
terms.clearCreditIdTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. boolean supportsCreditQuery()
supportsCreditQuery
in interface OsidObjectQuery
true
if a credit query is available,
false
otherwisemandatory
- This method must be implemented. CreditQuery getCreditQuery()
getCreditQuery
in interface OsidObjectQuery
UnimplementedException
- supportsCreditQuery()
is false
optional
- This method must be implemented if
supportsCreditQuery()
is true.
void matchAnyCredit(boolean match)
matchAnyCredit
in interface OsidObjectQuery
match
- true
to match billings with any credit,
false
to match billings with no creditsmandatory
- This method must be implemented. void clearCreditTerms()
clearCreditTerms
in interface OsidObjectQuery
mandatory
- This method must be implemented. void matchAncestorBillingId(Id billingId, boolean match)
Id
for this query to match billings
that have the specified billing as an ancestor.billingId
- a billing Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- billingId
is
null
mandatory
- This method must be implemented. void clearAncestorBillingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorBillingQuery()
BillingQuery
is available. true
if a billing query is available,
false
otherwisemandatory
- This method must be implemented. BillingQuery getAncestorBillingQuery()
OR
term.UnimplementedException
-
supportsAncestorBillingQuery()
is false
optional
- This method must be implemented if
supportsAncestorBillingQuery()
is true.
void matchAnyAncestorBilling(boolean match)
match
- true
to match billings with any ancestor,
false
to match root billingsmandatory
- This method must be implemented. void clearAncestorBillingTerms()
mandatory
- This method must be implemented. void matchDescendantBillingId(Id billingId, boolean match)
Id
for this query to match billings
that have the specified billing as a descendant.billingId
- a billing Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- billingId
is
null
mandatory
- This method must be implemented. void clearDescendantBillingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantBillingQuery()
BillingQuery
is available. true
if a billing query is available,
false
otherwisemandatory
- This method must be implemented. BillingQuery getDescendantBillingQuery()
OR
term.UnimplementedException
-
supportsDescendantBillingQuery()
is false
optional
- This method must be implemented if
supportsDescendantBillingQuery()
is true.
void matchAnyDescendantBilling(boolean match)
match
- true
to match billings with any
descendant, false
to match leaf billingsmandatory
- This method must be implemented. void clearDescendantBillingTerms()
mandatory
- This method must be implemented. BillingQueryRecord getBillingQueryRecord(Type billingRecordType) throws OperationFailedException
Billing
record Type.
Multiple record retrievals produce
a nested boolean OR
term.billingRecordType
- a billing record typeNullArgumentException
- billingRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(billingRecordType)
is false
mandatory
- This method must be implemented.