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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested boolean OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsCreditQuery()} is {@code 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 {@code supportsAncestorBillingQuery()} is {@code 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 {@code supportsDescendantBillingQuery()} is {@code 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.