public abstract class AbstractTxn extends java.lang.Object implements Txn
| Modifier and Type | Field and Description |
|---|---|
static int |
BANK_TRANSACTION_TYPE |
static int |
SPLIT_TRANSACTION_TYPE |
static byte |
STATUS_CLEARED |
static byte |
STATUS_RECONCILING |
static byte |
STATUS_UNRECONCILED |
static java.lang.String |
TAG_FI_ID |
static java.lang.String |
TAG_FITID_PREFIX |
static java.lang.String |
TAG_INVST_SPLIT_EXP |
static java.lang.String |
TAG_INVST_SPLIT_FEE |
static java.lang.String |
TAG_INVST_SPLIT_INC |
static java.lang.String |
TAG_INVST_SPLIT_SEC |
static java.lang.String |
TAG_INVST_SPLIT_TYPE |
static java.lang.String |
TAG_INVST_SPLIT_XFR |
static java.lang.String |
TAG_IS_NEW_TXN |
static java.lang.String |
TAG_ONLINE_PMT_ID |
static java.lang.String |
TAG_QIF_IMPORT_SESSION |
static java.lang.String |
TAG_QIF_INVST_ACTION |
static java.lang.String |
TAG_RECON_ASOFDT |
static java.lang.String |
TAG_RECON_DATE |
static java.lang.String |
TAG_SPLIT_ADDED |
static java.lang.String |
TAG_SPLIT_AMOUNT |
static java.lang.String |
TAG_SPLIT_CALC |
static java.lang.String |
TAG_SPLIT_PAIR |
static java.lang.String |
TRANSFER_TYPE_BANK |
static java.lang.String |
TRANSFER_TYPE_BUYSELL |
static java.lang.String |
TRANSFER_TYPE_BUYSELLXFR |
static java.lang.String |
TRANSFER_TYPE_DIVIDEND |
static java.lang.String |
TRANSFER_TYPE_DIVIDENDXFR |
static java.lang.String |
TRANSFER_TYPE_MISCINCEXP |
static java.lang.String |
TRANSFER_TYPE_SHORTCOVER |
| Constructor and Description |
|---|
AbstractTxn(Account account,
java.lang.String description,
long txnId,
byte status)
Construct a transaction with the given account, description,
transaction ID (-1 for a new transaction) and status.
|
| Modifier and Type | Method and Description |
|---|---|
Account |
getAccount()
Get the account associated with this transaction.
|
int |
getCheckNumAsInt()
Get the check number as an integer (returns 0 if it's not an integer)
|
abstract java.lang.String |
getCheckNumber()
Get the checknumber associated with this transaction.
|
abstract long |
getDate()
Deprecated.
use getDateInt() instead
|
abstract long |
getDateEntered()
Get the date that this transaction was entered.
|
abstract int |
getDateInt()
Get the date of this transaction
|
java.lang.String |
getDescription()
Get the description associated with this transaction.
|
java.lang.String |
getFIID()
Returns the identifier for the financial institution from which this
transaction was downloaded, or null if no financial institution information
has been provided.
|
java.lang.String |
getFiTxnId(int protocolId)
Return the ID that the financial institution uses to
identify this transaction.
|
abstract AbstractTxn |
getOtherTxn(int i)
Get the transaction that make up the other side of this
transaction at the specified index.
|
abstract int |
getOtherTxnCount()
Get the number of transactions from the "other side" of this
transaction.
|
abstract ParentTxn |
getParentTxn()
Get the ParentTxn of this transfer.
|
byte |
getStatus()
Get the status associated with this transaction.
|
char |
getStatusChar()
Get a character that indicates the status of this transaction
|
java.lang.String |
getTag(java.lang.String key)
Get the value associated with the given key (if any) in this
transaction's set of tags.
|
java.lang.String |
getTag(java.lang.String key,
java.lang.String defaultVal)
Get the value associated with the given key in this
transactions set of tags.
|
TagSet |
getTags() |
abstract long |
getTaxDate()
Deprecated.
use getTaxDateInt() instead
|
abstract int |
getTaxDateInt()
Get the date of this transaction for tax purposes.
|
abstract java.lang.String |
getTransferType()
Get the type of transaction.
|
long |
getTxnId()
Get the transaction ID.
|
abstract long |
getValue()
Get the value of this transaction, in the currency assigned
to the account for this transaction.
|
boolean |
isDirty()
Returns true if this transaction has been modified since
it was last saved.
|
boolean |
isNew()
Returns whether or not this transaction should be considered "unread" since having been downloaded
|
abstract boolean |
isTransferTo(Account acct)
Check whether or not this transaction includes a transfer
to the given account.
|
boolean |
needsToBePrinted()
Returns true if this transaction has been marked as
to-be-printed.
|
void |
removeTag(java.lang.String key)
Remove the key-value pair with the given key from the
set of tags.
|
void |
resetDirty()
Mark this transaction as unmodified.
|
void |
setAccount(Account newAccount)
Set the account associated with this transaction.
|
void |
setDescription(java.lang.String newDescription)
Set the description associated with this transaction.
|
void |
setDirty()
Mark this transaction as modified, and needing to be saved.
|
void |
setFIID(java.lang.String fiID)
Sets the identifier for the financial institution from which this
transaction was downloaded.
|
void |
setFiTxnId(int protocolId,
java.lang.String fitid)
Set the ID that the financial institution uses to
identify this transaction.
|
void |
setIsNew(boolean isNew)
Sets whether or not this transaction should be considered "unread" since having been downloaded
|
void |
setStatus(byte newStatus)
Set the status associated with this transaction.
|
void |
setTag(java.lang.String key,
java.lang.String value)
Set the value associated with the specified key in this
reminders set of tags.
|
void |
setTags(TagSet newTags)
Set the TagSet associated with this object.
|
boolean |
wasDownloaded()
Return true iff this transaction has a FI transaction ID associated with it.
|
public static final byte STATUS_CLEARED
public static final byte STATUS_RECONCILING
public static final byte STATUS_UNRECONCILED
public static final int BANK_TRANSACTION_TYPE
public static final int SPLIT_TRANSACTION_TYPE
public static final java.lang.String TRANSFER_TYPE_BANK
public static final java.lang.String TRANSFER_TYPE_BUYSELL
public static final java.lang.String TRANSFER_TYPE_SHORTCOVER
public static final java.lang.String TRANSFER_TYPE_BUYSELLXFR
public static final java.lang.String TRANSFER_TYPE_DIVIDEND
public static final java.lang.String TRANSFER_TYPE_DIVIDENDXFR
public static final java.lang.String TRANSFER_TYPE_MISCINCEXP
public static final java.lang.String TAG_FITID_PREFIX
public static final java.lang.String TAG_FI_ID
public static final java.lang.String TAG_ONLINE_PMT_ID
public static final java.lang.String TAG_QIF_IMPORT_SESSION
public static final java.lang.String TAG_QIF_INVST_ACTION
public static final java.lang.String TAG_SPLIT_CALC
public static final java.lang.String TAG_SPLIT_ADDED
public static final java.lang.String TAG_SPLIT_AMOUNT
public static final java.lang.String TAG_SPLIT_PAIR
public static final java.lang.String TAG_IS_NEW_TXN
public static final java.lang.String TAG_INVST_SPLIT_TYPE
public static final java.lang.String TAG_INVST_SPLIT_FEE
public static final java.lang.String TAG_INVST_SPLIT_SEC
public static final java.lang.String TAG_INVST_SPLIT_XFR
public static final java.lang.String TAG_INVST_SPLIT_EXP
public static final java.lang.String TAG_INVST_SPLIT_INC
public static final java.lang.String TAG_RECON_DATE
public static final java.lang.String TAG_RECON_ASOFDT
public AbstractTxn(Account account, java.lang.String description, long txnId, byte status)
public abstract long getDate()
public abstract long getDateEntered()
getDateEntered in interface Txnpublic abstract long getTaxDate()
public abstract int getDateInt()
getDateInt in interface Txnpublic abstract int getTaxDateInt()
getTaxDateInt in interface Txnpublic abstract long getValue()
public abstract ParentTxn getParentTxn()
getParentTxn in interface Txnpublic abstract int getOtherTxnCount()
getOtherTxnCount in interface Txnpublic abstract AbstractTxn getOtherTxn(int i)
getOtherTxn in interface Txnpublic abstract boolean isTransferTo(Account acct)
isTransferTo in interface Txnpublic abstract java.lang.String getTransferType()
getTransferType in interface Txnpublic final long getTxnId()
public final Account getAccount()
getAccount in interface Txnpublic final void setAccount(Account newAccount)
public final java.lang.String getDescription()
getDescription in interface Txnpublic final void setDescription(java.lang.String newDescription)
public final char getStatusChar()
getStatusChar in interface Txnpublic final byte getStatus()
public final void setStatus(byte newStatus)
public abstract java.lang.String getCheckNumber()
getCheckNumber in interface Txnpublic int getCheckNumAsInt()
getCheckNumAsInt in interface Txnpublic final java.lang.String getFiTxnId(int protocolId)
public final void setFiTxnId(int protocolId,
java.lang.String fitid)
public final java.lang.String getFIID()
public final void setFIID(java.lang.String fiID)
public final boolean wasDownloaded()
wasDownloaded in interface Txnpublic boolean isNew()
public void setIsNew(boolean isNew)
public final boolean isDirty()
public final void setDirty()
public final void resetDirty()
public final TagSet getTags()
public final java.lang.String getTag(java.lang.String key)
public final java.lang.String getTag(java.lang.String key,
java.lang.String defaultVal)
public final void setTag(java.lang.String key,
java.lang.String value)
public final void removeTag(java.lang.String key)
public final void setTags(TagSet newTags)
public final boolean needsToBePrinted()