Interface PaymentQuery

All Superinterfaces:

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

public interface PaymentQuery
extends OsidObjectQuery

This is the query for searching payments. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

Method Summary

Modifier and Type	Method	Description
void	clearAmountTerms()	Clears the amount.
void	clearBusinessIdTerms()	Clears the business Id terms.
void	clearBusinessTerms()	Clears the business terms.
void	clearCustomerIdTerms()	Clears the customer Id terms.
void	clearCustomerTerms()	Clears the customer terms.
void	clearPayerIdTerms()	Clears the payer Id terms.
void	clearPayerTerms()	Clears the payer terms.
void	clearPaymentDateTerms()	Clears the payment date terms.
void	clearPeriodIdTerms()	Clears the billing period Id terms.
void	clearPeriodTerms()	Clears the billing period terms.
void	clearProcessDateTerms()	Clears the process date terms.
BusinessQuery	getBusinessQuery()	Gets the query for a business.
CustomerQuery	getCustomerQuery()	Gets the query for a customer.
PayerQuery	getPayerQuery()	Gets the query for a payer.
PaymentQueryRecord	getPaymentQueryRecord(Type paymentRecordType)	Gets the payment query record corresponding to the given Payment record Type .Multiple record retrievals produce a nested OR term.
PeriodQuery	getPeriodQuery()	Gets the query for a billing period.
void	matchAmount(Currency from, Currency to, boolean match)	Matches amounts between the given range inclusive.
void	matchAnyAmount(boolean match)	Matches payments with any amount.
void	matchAnyPeriod(boolean match)	Matches payments with any billing period.
void	matchAnyProcessDate(boolean match)	Matches payments with any process date.
void	matchBusinessId(Id businessId, boolean match)	Sets the business Id for this query to match payments assigned to businesses.
void	matchCustomerId(Id customerId, boolean match)	Sets the customer Id for this query.
void	matchPayerId(Id payerId, boolean match)	Sets the payer Id for this query.
void	matchPaymentDate(DateTime from, DateTime to, boolean match)	Matches payment dates between the given date range inclusive.
void	matchPeriodId(Id periodId, boolean match)	Sets the biliing period Id for this query.
void	matchProcessDate(DateTime from, DateTime to, boolean match)	Matches process dates between the given date range inclusive.
boolean	supportsBusinessQuery()	Tests if a BusinessQuery is available.
boolean	supportsCustomerQuery()	Tests if a CustomereQuery is available.
boolean	supportsPayerQuery()	Tests if a PayerQuery is available.
boolean	supportsPeriodQuery()	Tests if a PeriodQuery 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, 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit 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.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
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	matchAnyCredit(boolean match)	Matches an object that has any Credit .
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	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
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	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
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.

Method Details

matchPayerId

void matchPayerId(Id payerId,
 boolean match)

Sets the payer Id for this query.

Parameters:

payerId - a payer Id

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

Throws:

NullArgumentException - payerId is null

Compliance:

mandatory - This method must be implemented.

clearPayerIdTerms

void clearPayerIdTerms()

Clears the payer Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPayerQuery

boolean supportsPayerQuery()

Tests if a PayerQuery is available.

Returns:

true if a payer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPayerQuery

PayerQuery getPayerQuery()

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

Returns:

the payer query

Throws:

UnimplementedException - supportsPayerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPayerQuery()} is {@code true} .

clearPayerTerms

void clearPayerTerms()

Clears the payer terms.

Compliance:

mandatory - This method must be implemented.

matchCustomerId

void matchCustomerId(Id customerId,
 boolean match)

Sets the customer Id for this query.

Parameters:

customerId - a customer Id

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

Throws:

NullArgumentException - customerId is null

Compliance:

mandatory - This method must be implemented.

clearCustomerIdTerms

void clearCustomerIdTerms()

Clears the customer Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCustomerQuery

boolean supportsCustomerQuery()

Tests if a CustomereQuery is available.

Returns:

true if a customer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCustomerQuery

CustomerQuery getCustomerQuery()

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

Returns:

a customer query

Throws:

UnimplementedException - supportsCustomerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCustomerQuery()} is {@code true} .

clearCustomerTerms

void clearCustomerTerms()

Clears the customer terms.

Compliance:

mandatory - This method must be implemented.

matchPeriodId

void matchPeriodId(Id periodId,
 boolean match)

Sets the biliing period Id for this query.

Parameters:

periodId - a period Id

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

Throws:

NullArgumentException - periodId is null

Compliance:

mandatory - This method must be implemented.

clearPeriodIdTerms

void clearPeriodIdTerms()

Clears the billing period Id terms.

Compliance:

mandatory - This method must be implemented.

supportsPeriodQuery

boolean supportsPeriodQuery()

Tests if a PeriodQuery is available.

Returns:

true if a period query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPeriodQuery

PeriodQuery getPeriodQuery()

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

Returns:

the period query

Throws:

UnimplementedException - supportsPeriodQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsPeriodQuery()} is {@code true} .

matchAnyPeriod

void matchAnyPeriod(boolean match)

Matches payments with any billing period.

Parameters:

match - true to match payments with any period, false to match peyments with no period

Compliance:

mandatory - This method must be implemented.

clearPeriodTerms

void clearPeriodTerms()

Clears the billing period terms.

Compliance:

mandatory - This method must be implemented.

matchPaymentDate

void matchPaymentDate(DateTime from,
 DateTime to,
 boolean match)

Matches payment dates between the given date range inclusive.

Parameters:

from - start of date range

to - end of date range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

clearPaymentDateTerms

void clearPaymentDateTerms()

Clears the payment date terms.

Compliance:

mandatory - This method must be implemented.

matchProcessDate

void matchProcessDate(DateTime from,
 DateTime to,
 boolean match)

Matches process dates between the given date range inclusive.

Parameters:

from - start of date range

to - end of date range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyProcessDate

void matchAnyProcessDate(boolean match)

Matches payments with any process date.

Parameters:

match - true to match payments with any process date, false to match peyments with no process date

Compliance:

mandatory - This method must be implemented.

clearProcessDateTerms

void clearProcessDateTerms()

Clears the process date terms.

Compliance:

mandatory - This method must be implemented.

matchAmount

void matchAmount(Currency from,
 Currency to,
 boolean match)

Matches amounts between the given range inclusive.

Parameters:

from - start of range

to - end of range

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

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

Compliance:

mandatory - This method must be implemented.

matchAnyAmount

void matchAnyAmount(boolean match)

Matches payments with any amount.

Parameters:

match - true to match payments with any amount, false to match peyments with no amount

Compliance:

mandatory - This method must be implemented.

clearAmountTerms

void clearAmountTerms()

Clears the amount.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
 boolean match)

Sets the business Id for this query to match payments assigned to businesses.

Parameters:

businessId - the business Id

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

Throws:

NullArgumentException - businessId is null

Compliance:

mandatory - This method must be implemented.

clearBusinessIdTerms

void clearBusinessIdTerms()

Clears the business Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBusinessQuery

boolean supportsBusinessQuery()

Tests if a BusinessQuery is available.

Returns:

true if a business query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBusinessQuery

BusinessQuery getBusinessQuery()

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

Returns:

the business query

Throws:

UnimplementedException - supportsBusinessQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsBusinessQuery()} is {@code true} .

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getPaymentQueryRecord

PaymentQueryRecord getPaymentQueryRecord(Type paymentRecordType)
                                  throws OperationFailedException

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

Parameters:

paymentRecordType - a payment record type

Returns:

the payment query record

Throws:

NullArgumentException - paymentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(paymentRecordType) is false

Compliance:

mandatory - This method must be implemented.