org.osid.billing.payment

Interface PayerQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

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.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchResourceId

void matchResourceId(Id resourceId,
                   boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

a resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

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

clearResourceTerms

void clearResourceTerms()

Clears the resource 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 supportsCustomerQuery() is true.

matchAnyCustomer

void matchAnyCustomer(boolean match)

Matches payers with any related customer.

Parameters:

match - true to match payers with any related customer, false to match payers with no customer

Compliance:

mandatory - This method must be implemented.

clearCustomerTerms

void clearCustomerTerms()

Clears the customer terms.

Compliance:

mandatory - This method must be implemented.

matchUsesActivity

void matchUsesActivity(boolean match)

Matches payers using their activity account.

Parameters:

match - true to match payers using an activity, false otherwise

Compliance:

mandatory - This method must be implemented.

clearUsesActivityTerms

void clearUsesActivityTerms()

Clears the activity terms.

Compliance:

mandatory - This method must be implemented.

matchUsesCash

void matchUsesCash(boolean match)

Matches payers using cash.

Parameters:

match - true to match payers using cash, false otherwise

Compliance:

mandatory - This method must be implemented.

clearUsesCashTerms

void clearUsesCashTerms()

Clears the cash terms.

Compliance:

mandatory - This method must be implemented.

matchCreditCardNumber

void matchCreditCardNumber(java.lang.String number,
                         Type stringMatchType,
                         boolean match)

Matches credit card numbers.

Parameters:

number - a credit card number

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - number not of stringMatchType

NullArgumentException - number or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyCreditCardNumber

void matchAnyCreditCardNumber(boolean match)

Matches payers with any credit card.

Parameters:

match - true to match payers with any credit card, false to match payers with no credit card

Compliance:

mandatory - This method must be implemented.

clearCreditCardNumberTerms

void clearCreditCardNumberTerms()

Clears the credit card number terms.

Compliance:

mandatory - This method must be implemented.

matchCreditCardExpiration

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

Matches credit card expirations 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.

matchAnyCreditCardExpiration

void matchAnyCreditCardExpiration(boolean match)

Matches payers with any credit card expiration date.

Parameters:

match - true to match payers with any credit card expiration, false to match payers with no credit card expiration

Compliance:

mandatory - This method must be implemented.

clearCreditCardExpirationTerms

void clearCreditCardExpirationTerms()

Clears the credit card expiration terms.

Compliance:

mandatory - This method must be implemented.

matchCreditCardCode

void matchCreditCardCode(java.lang.String code,
                       Type stringMatchType,
                       boolean match)

Matches credit card security codes.

Parameters:

code - a credit card code

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - code not of stringMatchType

NullArgumentException - code or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyCreditCardCode

void matchAnyCreditCardCode(boolean match)

Matches payers with any credit card security code.

Parameters:

match - true to match payers with any credit card security code, false to match payers with no credit card security code

Compliance:

mandatory - This method must be implemented.

clearCreditCardCodeTerms

void clearCreditCardCodeTerms()

Clears the credit card code terms.

Compliance:

mandatory - This method must be implemented.

matchBankRoutingNumber

void matchBankRoutingNumber(java.lang.String number,
                          Type stringMatchType,
                          boolean match)

Matches bank routing numbers.

Parameters:

number - a bank routing number

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - number not of stringMatchType

NullArgumentException - number or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyBankRoutingNumber

void matchAnyBankRoutingNumber(boolean match)

Matches payers with any bank routing number.

Parameters:

match - true to match payers with any bank routing number, false to match payers with no bank routing number

Compliance:

mandatory - This method must be implemented.

clearBankRoutingNumberTerms

void clearBankRoutingNumberTerms()

Clears the bank routing number terms.

Compliance:

mandatory - This method must be implemented.

matchBankAccountNumber

void matchBankAccountNumber(java.lang.String number,
                          Type stringMatchType,
                          boolean match)

Matches bank account numbers.

Parameters:

number - a bank account number

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - number not of stringMatchType

NullArgumentException - number or stringMatchType is null

Compliance:

mandatory - This method must be implemented.

matchAnyBankAccountNumber

void matchAnyBankAccountNumber(boolean match)

Matches payers with any bank account number.

Parameters:

match - true to match payers with any bank account number, false to match payers with no bank account number

Compliance:

mandatory - This method must be implemented.

clearBankAccountNumberTerms

void clearBankAccountNumberTerms()

Clears the bank account number terms.

Compliance:

mandatory - This method must be implemented.

matchBusinessId

void matchBusinessId(Id businessId,
                   boolean match)

Sets the business Id for this query to match payers 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 supportsBusinessQuery() is true.

clearBusinessTerms

void clearBusinessTerms()

Clears the business terms.

Compliance:

mandatory - This method must be implemented.

getPayerQueryRecord

PayerQueryRecord getPayerQueryRecord(Type payerRecordType)
                                     throws OperationFailedException

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

Parameters:

payerRecordType - a payer record type

Returns:

the payer query record

Throws:

NullArgumentException - payerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(payerRecordType) is false

Compliance:

mandatory - This method must be implemented.