org.osid.acknowledgement

Interface BillingQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectQuery

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

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

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchCreditId

void matchCreditId(Id creditId,
                 boolean match)

Sets the credit Id for this query to match credits assigned to billings.

Specified by:

matchCreditId in interface OsidObjectQuery

Parameters:

creditId - a credit Id

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

Throws:

NullArgumentException - creditId is null

Compliance:

mandatory - This method must be implemented.

clearCreditIdTerms

void clearCreditIdTerms()

Clears all credit Id terms.

Specified by:

clearCreditIdTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

supportsCreditQuery

boolean supportsCreditQuery()

Tests if a credit query is available.

Specified by:

supportsCreditQuery in interface OsidObjectQuery

Returns:

true if a credit query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCreditQuery

CreditQuery getCreditQuery()

Gets the query for a billing.

Specified by:

getCreditQuery in interface OsidObjectQuery

Returns:

the credit query

Throws:

UnimplementedException - supportsCreditQuery() is false

Compliance:

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

matchAnyCredit

void matchAnyCredit(boolean match)

Matches billings with any credit.

Specified by:

matchAnyCredit in interface OsidObjectQuery

Parameters:

match - true to match billings with any credit, false to match billings with no credits

Compliance:

mandatory - This method must be implemented.

clearCreditTerms

void clearCreditTerms()

Clears all credit terms.

Specified by:

clearCreditTerms in interface OsidObjectQuery

Compliance:

mandatory - This method must be implemented.

matchAncestorBillingId

void matchAncestorBillingId(Id billingId,
                          boolean match)

Sets the billing Id for this query to match billings that have the specified billing as an ancestor.

Parameters:

billingId - a billing Id

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

Throws:

NullArgumentException - billingId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorBillingIdTerms

void clearAncestorBillingIdTerms()

Clears all ancestor billing Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorBillingQuery

boolean supportsAncestorBillingQuery()

Tests if a BillingQuery is available.

Returns:

true if a billing query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorBillingQuery

BillingQuery getAncestorBillingQuery()

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

Returns:

the billing query

Throws:

UnimplementedException - supportsAncestorBillingQuery() is false

Compliance:

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

matchAnyAncestorBilling

void matchAnyAncestorBilling(boolean match)

Matches billings with any ancestor.

Parameters:

match - true to match billings with any ancestor, false to match root billings

Compliance:

mandatory - This method must be implemented.

clearAncestorBillingTerms

void clearAncestorBillingTerms()

Clears all ancestor billing terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantBillingId

void matchDescendantBillingId(Id billingId,
                            boolean match)

Sets the billing Id for this query to match billings that have the specified billing as a descendant.

Parameters:

billingId - a billing Id

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

Throws:

NullArgumentException - billingId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantBillingIdTerms

void clearDescendantBillingIdTerms()

Clears all descendant billing Id terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantBillingQuery

boolean supportsDescendantBillingQuery()

Tests if a BillingQuery is available.

Returns:

true if a billing query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantBillingQuery

BillingQuery getDescendantBillingQuery()

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

Returns:

the billing query

Throws:

UnimplementedException - supportsDescendantBillingQuery() is false

Compliance:

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

matchAnyDescendantBilling

void matchAnyDescendantBilling(boolean match)

Matches billings with any descendant.

Parameters:

match - true to match billings with any descendant, false to match leaf billings

Compliance:

mandatory - This method must be implemented.

clearDescendantBillingTerms

void clearDescendantBillingTerms()

Clears all descendant billing terms.

Compliance:

mandatory - This method must be implemented.

getBillingQueryRecord

BillingQueryRecord getBillingQueryRecord(Type billingRecordType)
                                         throws OperationFailedException

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

Parameters:

billingRecordType - a billing record type

Returns:

the billing query record

Throws:

NullArgumentException - billingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(billingRecordType) is false

Compliance:

mandatory - This method must be implemented.