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.
Modifier and Type | Method and 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. |
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. |
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
void matchPayerId(Id payerId, boolean match)
Id
for this query.payerId
- a payer Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- payerId
is
null
mandatory
- This method must be implemented. void clearPayerIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPayerQuery()
PayerQuery
is available. true
if a payer query is available,
false
otherwisemandatory
- This method must be implemented. PayerQuery getPayerQuery()
OR
term.UnimplementedException
- supportsPayerQuery()
is false
optional
- This method must be implemented if
supportsPayerQuery()
is true.
void clearPayerTerms()
mandatory
- This method must be implemented. void matchCustomerId(Id customerId, boolean match)
Id
for this query.customerId
- a customer Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- customerId
is
null
mandatory
- This method must be implemented. void clearCustomerIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCustomerQuery()
CustomereQuery
is available. true
if a customer query is available,
false
otherwisemandatory
- This method must be implemented. CustomerQuery getCustomerQuery()
OR
term.UnimplementedException
- supportsCustomerQuery()
is false
optional
- This method must be implemented if
supportsCustomerQuery()
is true.
void clearCustomerTerms()
mandatory
- This method must be implemented. void matchPeriodId(Id periodId, boolean match)
Id
for this query.periodId
- a period Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- periodId
is
null
mandatory
- This method must be implemented. void clearPeriodIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsPeriodQuery()
PeriodQuery
is available. true
if a period query is available,
false
otherwisemandatory
- This method must be implemented. PeriodQuery getPeriodQuery()
OR
term.UnimplementedException
- supportsPeriodQuery()
is false
optional
- This method must be implemented if
supportsPeriodQuery()
is true.
void matchAnyPeriod(boolean match)
match
- true
to match payments with any period,
false
to match peyments with no periodmandatory
- This method must be implemented. void clearPeriodTerms()
mandatory
- This method must be implemented. void matchPaymentDate(DateTime from, DateTime to, boolean match)
from
- start of date rangeto
- end of date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearPaymentDateTerms()
mandatory
- This method must be implemented. void matchProcessDate(DateTime from, DateTime to, boolean match)
from
- start of date rangeto
- end of date rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyProcessDate(boolean match)
match
- true
to match payments with any process
date, false
to match peyments with no process
datemandatory
- This method must be implemented. void clearProcessDateTerms()
mandatory
- This method must be implemented. void matchAmount(Currency from, Currency to, boolean match)
from
- start of rangeto
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void matchAnyAmount(boolean match)
match
- true
to match payments with any amount,
false
to match peyments with no amountmandatory
- This method must be implemented. void clearAmountTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match payments
assigned to businesses.businessId
- the business Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- businessId
is
null
mandatory
- This method must be implemented. void clearBusinessIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBusinessQuery()
BusinessQuery
is available. true
if a business query is available,
false
otherwisemandatory
- This method must be implemented. BusinessQuery getBusinessQuery()
OR
term.UnimplementedException
- supportsBusinessQuery()
is false
optional
- This method must be implemented if
supportsBusinessQuery()
is true.
void clearBusinessTerms()
mandatory
- This method must be implemented. PaymentQueryRecord getPaymentQueryRecord(Type paymentRecordType) throws OperationFailedException
Payment
record Type.
Multiple record retrievals
produce a nested OR
term.paymentRecordType
- a payment record typeNullArgumentException
- paymentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(paymentRecordType)
is false
mandatory
- This method must be implemented.