public interface PayerQuery extends OsidObjectQuery, OsidTemporalQuery
This is the query for searching payers. 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 |
clearBankAccountNumberTerms()
Clears the bank account number terms.
|
void |
clearBankRoutingNumberTerms()
Clears the bank routing number terms.
|
void |
clearBusinessIdTerms()
Clears the business
Id terms. |
void |
clearBusinessTerms()
Clears the business terms.
|
void |
clearCreditCardCodeTerms()
Clears the credit card code terms.
|
void |
clearCreditCardExpirationTerms()
Clears the credit card expiration terms.
|
void |
clearCreditCardNumberTerms()
Clears the credit card number terms.
|
void |
clearCustomerIdTerms()
Clears the customer
Id terms. |
void |
clearCustomerTerms()
Clears the customer terms.
|
void |
clearResourceIdTerms()
Clears the resource
Id terms. |
void |
clearResourceTerms()
Clears the resource terms.
|
void |
clearUsesActivityTerms()
Clears the activity terms.
|
void |
clearUsesCashTerms()
Clears the cash terms.
|
BusinessQuery |
getBusinessQuery()
Gets the query for a business.
|
CustomerQuery |
getCustomerQuery()
Gets the query for a customer.
|
PayerQueryRecord |
getPayerQueryRecord(Type payerRecordType)
Gets the payer query record corresponding to the given
Payer
record Type. |
ResourceQuery |
getResourceQuery()
Gets the query for a resource.
|
void |
matchAnyBankAccountNumber(boolean match)
Matches payers with any bank account number.
|
void |
matchAnyBankRoutingNumber(boolean match)
Matches payers with any bank routing number.
|
void |
matchAnyCreditCardCode(boolean match)
Matches payers with any credit card security code.
|
void |
matchAnyCreditCardExpiration(boolean match)
Matches payers with any credit card expiration date.
|
void |
matchAnyCreditCardNumber(boolean match)
Matches payers with any credit card.
|
void |
matchAnyCustomer(boolean match)
Matches payers with any related customer.
|
void |
matchBankAccountNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Matches bank account numbers.
|
void |
matchBankRoutingNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Matches bank routing numbers.
|
void |
matchBusinessId(Id businessId,
boolean match)
Sets the business
Id for this query to match payers
assigned to businesses. |
void |
matchCreditCardCode(java.lang.String code,
Type stringMatchType,
boolean match)
Matches credit card security codes.
|
void |
matchCreditCardExpiration(DateTime from,
DateTime to,
boolean match)
Matches credit card expirations between the given date range
inclusive.
|
void |
matchCreditCardNumber(java.lang.String number,
Type stringMatchType,
boolean match)
Matches credit card numbers.
|
void |
matchCustomerId(Id customerId,
boolean match)
Sets the customer
Id for this query. |
void |
matchResourceId(Id resourceId,
boolean match)
Sets the resource
Id for this query. |
void |
matchUsesActivity(boolean match)
Matches payers using their activity account.
|
void |
matchUsesCash(boolean match)
Matches payers using cash.
|
boolean |
supportsBusinessQuery()
Tests if a
BusinessQuery is available. |
boolean |
supportsCustomerQuery()
Tests if a
CustomereQuery is available. |
boolean |
supportsResourceQuery()
Tests if a
ResourceQuery 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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
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 matchAnyCustomer(boolean match)
match
- true
to match payers with any related
customer, false
to match payers with no
customermandatory
- This method must be implemented. void clearCustomerTerms()
mandatory
- This method must be implemented. void matchUsesActivity(boolean match)
match
- true
to match payers using an activity,
false otherwisemandatory
- This method must be implemented. void clearUsesActivityTerms()
mandatory
- This method must be implemented. void matchUsesCash(boolean match)
match
- true
to match payers using cash, false
otherwisemandatory
- This method must be implemented. void clearUsesCashTerms()
mandatory
- This method must be implemented. void matchCreditCardNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a credit card numberstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
mandatory
- This method must be implemented. void matchAnyCreditCardNumber(boolean match)
match
- true
to match payers with any credit
card, false
to match payers with no credit cardmandatory
- This method must be implemented. void clearCreditCardNumberTerms()
mandatory
- This method must be implemented. void matchCreditCardExpiration(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 matchAnyCreditCardExpiration(boolean match)
match
- true
to match payers with any credit card
expiration, false
to match payers with no
credit card expirationmandatory
- This method must be implemented. void clearCreditCardExpirationTerms()
mandatory
- This method must be implemented. void matchCreditCardCode(java.lang.String code, Type stringMatchType, boolean match)
code
- a credit card codestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- code
not of
stringMatchType
NullArgumentException
- code
or
stringMatchType
is null
mandatory
- This method must be implemented. void matchAnyCreditCardCode(boolean match)
match
- true
to match payers with any credit card
security code, false
to match payers with no
credit card security codemandatory
- This method must be implemented. void clearCreditCardCodeTerms()
mandatory
- This method must be implemented. void matchBankRoutingNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a bank routing numberstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
mandatory
- This method must be implemented. void matchAnyBankRoutingNumber(boolean match)
match
- true
to match payers with any bank
routing number, false
to match payers with no
bank routing numbermandatory
- This method must be implemented. void clearBankRoutingNumberTerms()
mandatory
- This method must be implemented. void matchBankAccountNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a bank account numberstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
not of
stringMatchType
NullArgumentException
- number
or
stringMatchType
is null
mandatory
- This method must be implemented. void matchAnyBankAccountNumber(boolean match)
match
- true
to match payers with any bank
account number, false
to match payers with no
bank account numbermandatory
- This method must be implemented. void clearBankAccountNumberTerms()
mandatory
- This method must be implemented. void matchBusinessId(Id businessId, boolean match)
Id
for this query to match payers
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. PayerQueryRecord getPayerQueryRecord(Type payerRecordType) throws OperationFailedException
Payer
record Type.
Multiple record retrievals produce
a nested OR
term.payerRecordType
- a payer record typeNullArgumentException
- payerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(payerRecordType)
is false
mandatory
- This method must be implemented.