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

All Superinterfaces:

java.lang.Comparable<ImmutableModelObject>, ImmutableModelObject, ImmutableTransaction

All Known Subinterfaces:

MutableScheduledTransaction

All Known Implementing Classes:

ImmutableScheduledTransactionImpl, MutableScheduledTransactionImpl

public interface ImmutableScheduledTransaction
extends ImmutableTransaction

Method Summary

java.util.Date	getEndDate() Returns the end date of the scheduled transaction.
java.lang.String	getFrequencyType() Returns the frequncy type.
java.util.Date	getLastDayCreated() Returns the last day which this scheduled transaction was used on.
java.lang.String	getMessage() Returns the message associated with the scheduled transaction.
int	getScheduleDay() Returns an integer representation of the scheduled transaction day.
ScheduledTransaction	getScheduledTransaction() Returns the wrapped object from the underlying data model.
int	getScheduleMonth() Returns an integer representation of the scheduled transaction month.
java.lang.String	getScheduleName() Returns the name of this scheduled transaction.
int	getScheduleWeek() Returns an integer representation of the scheduled transaction week.
java.util.Date	getStartDate() Returns the starting day of this scheduled transaction.

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

getAmount, getBalanceFrom, getBalanceTo, getDate, getDescription, getFrom, getMemo, getNumber, getTo, getTransaction, isClearedFrom, isClearedTo, isDeleted, isInflow, isReconciledFrom, isReconciledTo, isScheduled

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

getScheduledTransaction

ScheduledTransaction getScheduledTransaction()

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:

getEndDate

java.util.Date getEndDate()

Returns the end date of the scheduled transaction. After this date, the transaction is no longer active (although it stays in the list). As of August 31 2007, this method is not used, but is here for a future release which will support it.

Returns:

getFrequencyType

java.lang.String getFrequencyType()

Returns the frequncy type. This is a string representation of one of the ScheduleFrequency enum values.

Returns:

getLastDayCreated

java.util.Date getLastDayCreated()

Returns the last day which this scheduled transaction was used on. This is used to determine where to start looking for the next iteration.

Returns:

getMessage

java.lang.String getMessage()

Returns the message associated with the scheduled transaction.

Returns:

getScheduleDay

int getScheduleDay()

Returns an integer representation of the scheduled transaction day. Depending on the value of getFrequencyType(), this value may mean different things, or may not be used at all.

Returns:

getScheduleMonth

int getScheduleMonth()

Returns an integer representation of the scheduled transaction month. Depending on the value of getFrequencyType(), this value may mean different things, or may not be used at all.

Returns:

getScheduleName

java.lang.String getScheduleName()

Returns the name of this scheduled transaction. This is the name which will appear in the list of scheduled transactions.

Returns:

getScheduleWeek

int getScheduleWeek()

Returns an integer representation of the scheduled transaction week. Depending on the value of getFrequencyType(), this value may mean different things, or may not be used at all.

Returns:

getStartDate

java.util.Date getStartDate()

Returns the starting day of this scheduled transaction. No transactions will be added before this date.

Returns: