org.homeunix.thecave.buddi.plugin.api.model
Interface ImmutableTransaction

All Superinterfaces:

java.lang.Comparable<ImmutableModelObject>, ImmutableModelObject

All Known Subinterfaces:

ImmutableScheduledTransaction, MutableScheduledTransaction, MutableTransaction

All Known Implementing Classes:

ImmutableScheduledTransactionImpl, ImmutableTransactionImpl, MutableScheduledTransactionImpl, MutableTransactionImpl

public interface ImmutableTransaction
extends ImmutableModelObject

Method Summary

long	getAmount() Returns the amouns associated with this transaction
long	getBalanceFrom() Returns the balance in the From account at the point in time of this transaction
long	getBalanceTo() Returns the balance in the To account at the point in time of this transaction
java.util.Date	getDate() Returns the date associated with this transaction
java.lang.String	getDescription() Returns the description associated with this transaction
ImmutableSource	getFrom() Returns the source associated with this transaction's From field
java.lang.String	getMemo() Returns the memo associated with this transaction
java.lang.String	getNumber() Returns the cheque number associated with this transaction
ImmutableSource	getTo() Returns the source associated with this transaction's To field
Transaction	getTransaction() Returns the wrapped object from the underlying data model.
boolean	isClearedFrom() Is this transaction marked as cleared?
boolean	isClearedTo() Is this transaction marked as cleared?
boolean	isDeleted() Is the transaction marked as deleted?
boolean	isInflow() Does this transacton represent an inflow of cash or an outflow?
boolean	isReconciledFrom() Is this transaction marked as reconciled?
boolean	isReconciledTo() Is this transaction marked as reconciled?
boolean	isScheduled() Was this transaction created through a scheduled transaction?

Methods inherited from interface org.homeunix.thecave.buddi.plugin.api.model.ImmutableModelObject

getModified, getRaw, getUid

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAmount

long getAmount()

Returns the amouns associated with this transaction

Returns:

getBalanceFrom

long getBalanceFrom()

Returns the balance in the From account at the point in time of this transaction

Returns:

getBalanceTo

long getBalanceTo()

Returns the balance in the To account at the point in time of this transaction

Returns:

getDate

java.util.Date getDate()

Returns the date associated with this transaction

Returns:

getDescription

java.lang.String getDescription()

Returns the description associated with this transaction

Returns:

getFrom

ImmutableSource getFrom()

Returns the source associated with this transaction's From field

Returns:

getMemo

java.lang.String getMemo()

Returns the memo associated with this transaction

Returns:

getNumber

java.lang.String getNumber()

Returns the cheque number associated with this transaction

Returns:

getTo

ImmutableSource getTo()

Returns the source associated with this transaction's To field

Returns:

getTransaction

Transaction getTransaction()

Returns the wrapped object from the underlying data model. By accessing this method, you bypass all protection which the Buddi API gives you; it is not recommended to use this method unless you understand the risks associated with it.

Returns:

isClearedFrom

boolean isClearedFrom()

Is this transaction marked as cleared?

Returns:

isClearedTo

boolean isClearedTo()

Is this transaction marked as cleared?

Returns:

isInflow

boolean isInflow()

Does this transacton represent an inflow of cash or an outflow?

Returns:

isReconciledFrom

boolean isReconciledFrom()

Is this transaction marked as reconciled?

Returns:

isReconciledTo

boolean isReconciledTo()

Is this transaction marked as reconciled?

Returns:

isScheduled

boolean isScheduled()

Was this transaction created through a scheduled transaction?

Returns:

isDeleted

boolean isDeleted()

Is the transaction marked as deleted?

Returns: