com.moneydance.apps.md.model
Class OnlinePayment

java.lang.Object
  com.moneydance.apps.md.model.OnlinePayment

All Implemented Interfaces:

OnlineBankAcctFromInterface, OnlineBankAcctToInterface, OnlineExtdPayeeInterface, OnlinePayeeInterface, java.lang.Cloneable

public class OnlinePayment
extends java.lang.Object
implements OnlinePayeeInterface, OnlineBankAcctFromInterface, OnlineBankAcctToInterface, OnlineExtdPayeeInterface, java.lang.Cloneable

Simple payment object that describes payments that are stored in the users payment list on the online banking server.

Method Summary

java.lang.Object	clone()
java.lang.String	getAcctFromAcctID()
java.lang.String	getAcctFromBankID()
java.lang.String	getAcctFromBranchID()
java.lang.String	getAcctFromKey()
java.lang.String	getAcctFromType()
java.lang.String	getAcctToAcctID() get info identifying the account to transfer the money to/from if this was a transfer to/from a bank account
java.lang.String	getAcctToBankBranch() Set the branch of this payee's bank account.
java.lang.String	getAcctToBankCity() Get the city of this payee's bank.
java.lang.String	getAcctToBankID() get info identifying the bank to transfer the money to/from if this was a transfer to/from a bank account
java.lang.String	getAcctToBankName() Get the name of this payee's bank account.
java.lang.String	getAcctToBankPostal() Get the postal code of this payee's bank.
java.lang.String	getAcctToBranchID() Get the branch ID of the account for this payee.
java.lang.String	getAcctToKey() Get the key for this payee's account.
java.lang.String	getAcctToPTTAcctID() Get the PTT ID of this payee's bank.
java.lang.String	getAcctToType() Get the type of account for this payee.
java.lang.String	getAddr1()
java.lang.String	getAddr2()
java.lang.String	getAddr3()
java.lang.String	getAmount() Gets the amount of this payment.
java.lang.String	getBillerReference() Set the biller reference info that is associated with this payment.
int	getCategoryID() Return the category ID for payments to this payee, if any.
java.lang.String	getCheckNum() Set the check number that will/was associated with this payment.
java.lang.String	getCity()
java.lang.String	getCountry()
java.lang.String	getCurrency()
java.lang.String	getCustomerAcct() Get the account number of the customer that this payment is for.
long	getDateAvailable() Get the date that funds must be available in the destination account.
long	getDateDue()
int	getDaysToPay() Gets how many days before a payment is due that the money is deducted from the payer's account.
boolean	getHasBankAcctTo() Get whether or not there is destination bank account info.
boolean	getHasExtdPmtInfo() Get whether or not this payment has extra information.
boolean	getHasExtendedAcctToInfo() Get whether or not this payee has extended to-account information available.
boolean	getHasExtendedPayeeInfo() Gets whether or not an object has extended payee info associated with it.
java.lang.String	getMemo() Set the memo from the user to the payee that is associated with this payment.
java.lang.String	getPayeeID() Gets the ID used to identify this payee either globally or within the user's list of payees with this FI.
java.lang.String	getPayeeIDScope() Gets the scope of the payee ID...
java.lang.String	getPayeeListID()
java.lang.String	getPayeeName() Get the name of the payee
long	getPaymentDate() Gets the date of this payment.
java.lang.String	getPaymentExtdBookingTxt() Get the text that should appear on the statement for this payment, if the server supports extended payment info.
java.lang.String	getPaymentExtdDesc() Get the description for this payment, if the server supports extended payment info.
java.lang.String	getPaymentFor() Get the name of the person whom this payment is for.
java.lang.String	getPaymentID()
java.lang.String	getPaymentOnBehalfOf() Get the on-behalf-of for this payment, if the server supports extended payment info.
java.lang.String	getPaymentReason() Get the reason for this payment, if the server supports extended payment info.
java.lang.String	getPaymentStatus()
java.lang.String	getPhone()
java.lang.String	getPostalCode()
java.lang.String	getRecurringPmtRef()
java.lang.String	getState()
java.lang.String	getType()
boolean	isSameAs(OnlinePayment payment)
void	setAcctFromAcctID(java.lang.String acctID)
void	setAcctFromBankID(java.lang.String bankID)
void	setAcctFromBranchID(java.lang.String branchID)
void	setAcctFromKey(java.lang.String acctKey)
void	setAcctFromType(java.lang.String acctType)
void	setAcctToAcctID(java.lang.String toBankAccountID) set info identifying the account to transfer the money to/from if this was a transfer to/from a bank account
void	setAcctToBankBranch(java.lang.String bankBranch) Get the branch of this payee's bank account.
void	setAcctToBankCity(java.lang.String bankCity) Set the city of this payee's bank.
void	setAcctToBankID(java.lang.String toBankBankID) set info identifying the bank to transfer the money to/from if this was a transfer to/from a bank account
void	setAcctToBankName(java.lang.String bankName) Set the name of this payee's bank account.
void	setAcctToBankPostal(java.lang.String bankPostalCode) Set the postal code of this payee's bank.
void	setAcctToBranchID(java.lang.String branchID) Set the branch ID of the account for this payee.
void	setAcctToKey(java.lang.String acctKey) Set the key for this payee's account.
void	setAcctToPTTAcctID(java.lang.String pttAcctID) Set the PTT ID of this payee's bank.
void	setAcctToType(java.lang.String acctType) Set the type of account for this payee.
void	setAddr1(java.lang.String addr1)
void	setAddr2(java.lang.String addr2)
void	setAddr3(java.lang.String addr3)
void	setAmount(java.lang.String amtStr) Sets the amount of this payment.
void	setBillerReference(java.lang.String billerRef) Get the biller reference info that is associated with this payment.
void	setCategoryID(int newCategoryID) Sets the category for payments to this payee.
void	setCheckNum(java.lang.String checkNum) Get the check number that was associated with this payment.
void	setCity(java.lang.String city)
void	setCountry(java.lang.String country)
void	setCurrency(java.lang.String curr)
void	setCustomerAcct(java.lang.String custAcct) Set the account number of the customer that this payment is for.
void	setDateAvailable(long date) Set the date that funds must be available in the destination account.
void	setDateDue(long dateDue)
void	setDaysToPay(int daysToPay) Sets how many days before a payment is due that the money is deducted from the payer's account.
void	setHasBankAcctTo(boolean hasBankAcctTo) Set whether or not there is destination bank account info.
void	setHasExtdPmtInfo(boolean hasExtdInfo) Set whether or not this payment has extra information.
void	setHasExtendedAcctToInfo(boolean hasExtdInfo) Set whether or not this payee has extended to-account information available.
void	setHasExtendedPayeeInfo(boolean hasExtendedInfo) Sets whether or not an object has extended payee info associated with it.
void	setMemo(java.lang.String memo) Get the memo from the user to the payee that is associated with this payment.
void	setPayeeID(java.lang.String id) Sets the ID used to identify this payee either globally or within the user's list of payees with this FI.
void	setPayeeIDScope(java.lang.String idScope) Sets the scope of the payee ID...
void	setPayeeListID(java.lang.String payeeListID)
void	setPayeeName(java.lang.String name) Set the name of the payee
void	setPaymentBookingTxt(java.lang.String bookingText) Set the text that should appear on the statement for this payment, if the server supports extended payment info.
void	setPaymentDate(long pmtDate) Sets the payment date of this payment.
void	setPaymentExtdDesc(java.lang.String desc) Set the description for this payment, if the server supports extended payment info.
void	setPaymentFor(java.lang.String paymentFor) Set the name of the person whom this payment is for.
void	setPaymentID(java.lang.String id)
void	setPaymentOnBehalfOf(java.lang.String onBehalfOf) Set the on-behalf-of for this payment, if the server supports extended payment info.
void	setPaymentReason(java.lang.String reason) Set the reason for this payment, if the server supports extended payment info.
void	setPaymentStatus(java.lang.String statusStr)
void	setPhone(java.lang.String phone)
void	setPostalCode(java.lang.String postalcode)
void	setRecurringPmtRef(java.lang.String pmtRef) Set the reference to a recurring payment that was used to generate this payment, if any.
void	setState(java.lang.String state)
void	setType(java.lang.String pmtType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

setPaymentID

public void setPaymentID(java.lang.String id)

getPaymentID

public java.lang.String getPaymentID()

setPayeeListID

public void setPayeeListID(java.lang.String payeeListID)

getPayeeListID

public java.lang.String getPayeeListID()

setCurrency

public void setCurrency(java.lang.String curr)

getCurrency

public java.lang.String getCurrency()

setRecurringPmtRef

public void setRecurringPmtRef(java.lang.String pmtRef)

Set the reference to a recurring payment that was used to generate this payment, if any.

getRecurringPmtRef

public java.lang.String getRecurringPmtRef()

setCustomerAcct

public void setCustomerAcct(java.lang.String custAcct)

Set the account number of the customer that this payment is for.

getCustomerAcct

public java.lang.String getCustomerAcct()

Get the account number of the customer that this payment is for.

setDateDue

public void setDateDue(long dateDue)

getDateDue

public long getDateDue()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setPaymentStatus

public void setPaymentStatus(java.lang.String statusStr)

getPaymentStatus

public java.lang.String getPaymentStatus()

setType

public void setType(java.lang.String pmtType)

getType

public java.lang.String getType()

setCheckNum

public void setCheckNum(java.lang.String checkNum)

Get the check number that was associated with this payment.

getCheckNum

public java.lang.String getCheckNum()

Set the check number that will/was associated with this payment.

setMemo

public void setMemo(java.lang.String memo)

Get the memo from the user to the payee that is associated with this payment.

getMemo

public java.lang.String getMemo()

Set the memo from the user to the payee that is associated with this payment.

setBillerReference

public void setBillerReference(java.lang.String billerRef)

Get the biller reference info that is associated with this payment. This field has different contents depending on the country: BEL: Not present CAN: Not present CHE: Referenz-Nr, if applicable DEU: Not present ESP: Not present FRA: Not present GBR: Not present ITA: Coordinate Azienda, if applicable NLD: Betalingskenmerk, if applicable USA: Used to link bill payment to bill presentment

getBillerReference

public java.lang.String getBillerReference()

Set the biller reference info that is associated with this payment.

setDateAvailable

public void setDateAvailable(long date)

Set the date that funds must be available in the destination account. This is only supported if the getBillPaySupportsDtAvail method of the online service returns true.

getDateAvailable

public long getDateAvailable()

Get the date that funds must be available in the destination account. This is only supported if the getBillPaySupportsDtAvail method of the online service returns true. Returns a number <= 0 if this is not set.

setAmount

public void setAmount(java.lang.String amtStr)

Sets the amount of this payment.

getAmount

public java.lang.String getAmount()

Gets the amount of this payment.

setHasBankAcctTo

public void setHasBankAcctTo(boolean hasBankAcctTo)

Set whether or not there is destination bank account info.

Specified by:

setHasBankAcctTo in interface OnlineBankAcctToInterface

getHasBankAcctTo

public boolean getHasBankAcctTo()

Get whether or not there is destination bank account info.

Specified by:

getHasBankAcctTo in interface OnlineBankAcctToInterface

setAcctToAcctID

public void setAcctToAcctID(java.lang.String toBankAccountID)

set info identifying the account to transfer the money to/from if this was a transfer to/from a bank account

Specified by:

setAcctToAcctID in interface OnlineBankAcctToInterface

getAcctToAcctID

public java.lang.String getAcctToAcctID()

get info identifying the account to transfer the money to/from if this was a transfer to/from a bank account

Specified by:

getAcctToAcctID in interface OnlineBankAcctToInterface

setAcctToBankID

public void setAcctToBankID(java.lang.String toBankBankID)

set info identifying the bank to transfer the money to/from if this was a transfer to/from a bank account

Specified by:

setAcctToBankID in interface OnlineBankAcctToInterface

getAcctToBankID

public java.lang.String getAcctToBankID()

get info identifying the bank to transfer the money to/from if this was a transfer to/from a bank account

Specified by:

getAcctToBankID in interface OnlineBankAcctToInterface

setAcctToBranchID

public void setAcctToBranchID(java.lang.String branchID)

Set the branch ID of the account for this payee.

Specified by:

setAcctToBranchID in interface OnlineBankAcctToInterface

getAcctToBranchID

public java.lang.String getAcctToBranchID()

Get the branch ID of the account for this payee.

Specified by:

getAcctToBranchID in interface OnlineBankAcctToInterface

setAcctToType

public void setAcctToType(java.lang.String acctType)

Set the type of account for this payee.

Specified by:

setAcctToType in interface OnlineBankAcctToInterface

getAcctToType

public java.lang.String getAcctToType()

Get the type of account for this payee.

Specified by:

getAcctToType in interface OnlineBankAcctToInterface

setAcctToKey

public void setAcctToKey(java.lang.String acctKey)

Set the key for this payee's account.

Specified by:

setAcctToKey in interface OnlineBankAcctToInterface

getAcctToKey

public java.lang.String getAcctToKey()

Get the key for this payee's account.

Specified by:

getAcctToKey in interface OnlineBankAcctToInterface

setHasExtendedAcctToInfo

public void setHasExtendedAcctToInfo(boolean hasExtdInfo)

Set whether or not this payee has extended to-account information available.

Specified by:

setHasExtendedAcctToInfo in interface OnlineBankAcctToInterface

getHasExtendedAcctToInfo

public boolean getHasExtendedAcctToInfo()

Get whether or not this payee has extended to-account information available.

Specified by:

getHasExtendedAcctToInfo in interface OnlineBankAcctToInterface

setHasExtendedPayeeInfo

public void setHasExtendedPayeeInfo(boolean hasExtendedInfo)

Sets whether or not an object has extended payee info associated with it.

Specified by:

setHasExtendedPayeeInfo in interface OnlineExtdPayeeInterface

Specified by:

setHasExtendedPayeeInfo in interface OnlinePayeeInterface

getHasExtendedPayeeInfo

public boolean getHasExtendedPayeeInfo()

Gets whether or not an object has extended payee info associated with it.

Specified by:

getHasExtendedPayeeInfo in interface OnlineExtdPayeeInterface

Specified by:

getHasExtendedPayeeInfo in interface OnlinePayeeInterface

setAcctToBankName

public void setAcctToBankName(java.lang.String bankName)

Set the name of this payee's bank account.

Specified by:

setAcctToBankName in interface OnlineBankAcctToInterface

getAcctToBankName

public java.lang.String getAcctToBankName()

Get the name of this payee's bank account.

Specified by:

getAcctToBankName in interface OnlineBankAcctToInterface

setAcctToBankBranch

public void setAcctToBankBranch(java.lang.String bankBranch)

Get the branch of this payee's bank account.

Specified by:

setAcctToBankBranch in interface OnlineBankAcctToInterface

getAcctToBankBranch

public java.lang.String getAcctToBankBranch()

Set the branch of this payee's bank account.

Specified by:

getAcctToBankBranch in interface OnlineBankAcctToInterface

setAcctToBankCity

public void setAcctToBankCity(java.lang.String bankCity)

Set the city of this payee's bank.

Specified by:

setAcctToBankCity in interface OnlineBankAcctToInterface

getAcctToBankCity

public java.lang.String getAcctToBankCity()

Get the city of this payee's bank.

Specified by:

getAcctToBankCity in interface OnlineBankAcctToInterface

setAcctToBankPostal

public void setAcctToBankPostal(java.lang.String bankPostalCode)

Set the postal code of this payee's bank.

Specified by:

setAcctToBankPostal in interface OnlineBankAcctToInterface

getAcctToBankPostal

public java.lang.String getAcctToBankPostal()

Get the postal code of this payee's bank.

Specified by:

getAcctToBankPostal in interface OnlineBankAcctToInterface

setAcctToPTTAcctID

public void setAcctToPTTAcctID(java.lang.String pttAcctID)

Set the PTT ID of this payee's bank.

Specified by:

setAcctToPTTAcctID in interface OnlineBankAcctToInterface

getAcctToPTTAcctID

public java.lang.String getAcctToPTTAcctID()

Get the PTT ID of this payee's bank.

Specified by:

getAcctToPTTAcctID in interface OnlineBankAcctToInterface

setPayeeName

public void setPayeeName(java.lang.String name)

Description copied from interface: OnlineExtdPayeeInterface

Set the name of the payee

Specified by:

setPayeeName in interface OnlineExtdPayeeInterface

Specified by:

setPayeeName in interface OnlinePayeeInterface

getPayeeName

public java.lang.String getPayeeName()

Description copied from interface: OnlineExtdPayeeInterface

Get the name of the payee

Specified by:

getPayeeName in interface OnlineExtdPayeeInterface

Specified by:

getPayeeName in interface OnlinePayeeInterface

setAddr1

public void setAddr1(java.lang.String addr1)

Specified by:

setAddr1 in interface OnlinePayeeInterface

getAddr1

public java.lang.String getAddr1()

Specified by:

getAddr1 in interface OnlinePayeeInterface

setAddr2

public void setAddr2(java.lang.String addr2)

Specified by:

setAddr2 in interface OnlinePayeeInterface

getAddr2

public java.lang.String getAddr2()

Specified by:

getAddr2 in interface OnlinePayeeInterface

setAddr3

public void setAddr3(java.lang.String addr3)

Specified by:

setAddr3 in interface OnlinePayeeInterface

getAddr3

public java.lang.String getAddr3()

Specified by:

getAddr3 in interface OnlinePayeeInterface

setCity

public void setCity(java.lang.String city)

Specified by:

setCity in interface OnlinePayeeInterface

getCity

public java.lang.String getCity()

Specified by:

getCity in interface OnlinePayeeInterface

setState

public void setState(java.lang.String state)

Specified by:

setState in interface OnlinePayeeInterface

getState

public java.lang.String getState()

Specified by:

getState in interface OnlinePayeeInterface

setPostalCode

public void setPostalCode(java.lang.String postalcode)

Specified by:

setPostalCode in interface OnlinePayeeInterface

getPostalCode

public java.lang.String getPostalCode()

Specified by:

getPostalCode in interface OnlinePayeeInterface

setCountry

public void setCountry(java.lang.String country)

Specified by:

setCountry in interface OnlinePayeeInterface

getCountry

public java.lang.String getCountry()

Specified by:

getCountry in interface OnlinePayeeInterface

setPhone

public void setPhone(java.lang.String phone)

Specified by:

setPhone in interface OnlinePayeeInterface

getPhone

public java.lang.String getPhone()

Specified by:

getPhone in interface OnlinePayeeInterface

setDaysToPay

public void setDaysToPay(int daysToPay)

Sets how many days before a payment is due that the money is deducted from the payer's account. If the days-to-pay is -1 then the due date for a payment actually refers to when the payer's financial instution process the payment.

Specified by:

setDaysToPay in interface OnlineExtdPayeeInterface

Specified by:

setDaysToPay in interface OnlinePayeeInterface

getDaysToPay

public int getDaysToPay()

Gets how many days before a payment is due that the money is deducted from the payer's account. If the days-to-pay is -1 then the due date for a payment actually refers to when the payer's financial instution process the payment.

Specified by:

getDaysToPay in interface OnlineExtdPayeeInterface

Specified by:

getDaysToPay in interface OnlinePayeeInterface

setPayeeIDScope

public void setPayeeIDScope(java.lang.String idScope)

Sets the scope of the payee ID... either GLOBAL or USER.

Specified by:

setPayeeIDScope in interface OnlineExtdPayeeInterface

Specified by:

setPayeeIDScope in interface OnlinePayeeInterface

getPayeeIDScope

public java.lang.String getPayeeIDScope()

Gets the scope of the payee ID... either GLOBAL or USER.

Specified by:

getPayeeIDScope in interface OnlineExtdPayeeInterface

Specified by:

getPayeeIDScope in interface OnlinePayeeInterface

setPayeeID

public void setPayeeID(java.lang.String id)

Sets the ID used to identify this payee either globally or within the user's list of payees with this FI.

Specified by:

setPayeeID in interface OnlineExtdPayeeInterface

getPayeeID

public java.lang.String getPayeeID()

Gets the ID used to identify this payee either globally or within the user's list of payees with this FI.

Specified by:

getPayeeID in interface OnlineExtdPayeeInterface

setAcctFromBankID

public void setAcctFromBankID(java.lang.String bankID)

Specified by:

setAcctFromBankID in interface OnlineBankAcctFromInterface

getAcctFromBankID

public java.lang.String getAcctFromBankID()

Specified by:

getAcctFromBankID in interface OnlineBankAcctFromInterface

setAcctFromBranchID

public void setAcctFromBranchID(java.lang.String branchID)

Specified by:

setAcctFromBranchID in interface OnlineBankAcctFromInterface

getAcctFromBranchID

public java.lang.String getAcctFromBranchID()

Specified by:

getAcctFromBranchID in interface OnlineBankAcctFromInterface

setAcctFromAcctID

public void setAcctFromAcctID(java.lang.String acctID)

Specified by:

setAcctFromAcctID in interface OnlineBankAcctFromInterface

getAcctFromAcctID

public java.lang.String getAcctFromAcctID()

Specified by:

getAcctFromAcctID in interface OnlineBankAcctFromInterface

setAcctFromType

public void setAcctFromType(java.lang.String acctType)

Specified by:

setAcctFromType in interface OnlineBankAcctFromInterface

getAcctFromType

public java.lang.String getAcctFromType()

Specified by:

getAcctFromType in interface OnlineBankAcctFromInterface

setAcctFromKey

public void setAcctFromKey(java.lang.String acctKey)

Specified by:

setAcctFromKey in interface OnlineBankAcctFromInterface

getAcctFromKey

public java.lang.String getAcctFromKey()

Specified by:

getAcctFromKey in interface OnlineBankAcctFromInterface

setHasExtdPmtInfo

public void setHasExtdPmtInfo(boolean hasExtdInfo)

Set whether or not this payment has extra information.

getHasExtdPmtInfo

public boolean getHasExtdPmtInfo()

Get whether or not this payment has extra information.

setPaymentFor

public void setPaymentFor(java.lang.String paymentFor)

Set the name of the person whom this payment is for.

getPaymentFor

public java.lang.String getPaymentFor()

Get the name of the person whom this payment is for.

setPaymentExtdDesc

public void setPaymentExtdDesc(java.lang.String desc)

Set the description for this payment, if the server supports extended payment info.

getPaymentExtdDesc

public java.lang.String getPaymentExtdDesc()

Get the description for this payment, if the server supports extended payment info.

setPaymentReason

public void setPaymentReason(java.lang.String reason)

Set the reason for this payment, if the server supports extended payment info.

getPaymentReason

public java.lang.String getPaymentReason()

Get the reason for this payment, if the server supports extended payment info.

setPaymentOnBehalfOf

public void setPaymentOnBehalfOf(java.lang.String onBehalfOf)

Set the on-behalf-of for this payment, if the server supports extended payment info.

getPaymentOnBehalfOf

public java.lang.String getPaymentOnBehalfOf()

Get the on-behalf-of for this payment, if the server supports extended payment info.

setPaymentBookingTxt

public void setPaymentBookingTxt(java.lang.String bookingText)

Set the text that should appear on the statement for this payment, if the server supports extended payment info.

getPaymentExtdBookingTxt

public java.lang.String getPaymentExtdBookingTxt()

Get the text that should appear on the statement for this payment, if the server supports extended payment info.

setPaymentDate

public void setPaymentDate(long pmtDate)

Sets the payment date of this payment. This is only set by the server.

getPaymentDate

public long getPaymentDate()

Gets the date of this payment.

getCategoryID

public int getCategoryID()

Return the category ID for payments to this payee, if any.

setCategoryID

public void setCategoryID(int newCategoryID)

Sets the category for payments to this payee.

isSameAs

public boolean isSameAs(OnlinePayment payment)