org.homeunix.thecave.buddi.plugin.api.model.impl
Class ImmutableScheduledTransactionImpl

java.lang.Object
  org.homeunix.thecave.buddi.plugin.api.model.impl.ImmutableModelObjectImpl
      org.homeunix.thecave.buddi.plugin.api.model.impl.ImmutableTransactionImpl
          org.homeunix.thecave.buddi.plugin.api.model.impl.ImmutableScheduledTransactionImpl

All Implemented Interfaces:

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

public class ImmutableScheduledTransactionImpl
extends ImmutableTransactionImpl
implements ImmutableScheduledTransaction

Constructor Summary

ImmutableScheduledTransactionImpl(ScheduledTransaction scheduledTransaction)

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.
ScheduledTransaction	getTransaction() Returns the wrapped object from the underlying data model.

Methods inherited from class org.homeunix.thecave.buddi.plugin.api.model.impl.ImmutableTransactionImpl

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

Methods inherited from class org.homeunix.thecave.buddi.plugin.api.model.impl.ImmutableModelObjectImpl

compareTo, getModified, getRaw, getUid, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getAmount, getBalanceFrom, getBalanceTo, getDate, getDescription, getFrom, getMemo, getNumber, getTo, 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

Constructor Detail

ImmutableScheduledTransactionImpl

public ImmutableScheduledTransactionImpl(ScheduledTransaction scheduledTransaction)

Method Detail

getTransaction

public ScheduledTransaction getTransaction()

Description copied from interface: ImmutableTransaction

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.

Specified by:

getTransaction in interface ImmutableTransaction

Overrides:

getTransaction in class ImmutableTransactionImpl

Returns:

getScheduledTransaction

public ScheduledTransaction getScheduledTransaction()

Description copied from interface: ImmutableScheduledTransaction

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.

Specified by:

getScheduledTransaction in interface ImmutableScheduledTransaction

Returns:

getEndDate

public java.util.Date getEndDate()

Description copied from interface: ImmutableScheduledTransaction

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.

Specified by:

getEndDate in interface ImmutableScheduledTransaction

Returns:

getFrequencyType

public java.lang.String getFrequencyType()

Description copied from interface: ImmutableScheduledTransaction

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

Specified by:

getFrequencyType in interface ImmutableScheduledTransaction

Returns:

getLastDayCreated

public java.util.Date getLastDayCreated()

Description copied from interface: ImmutableScheduledTransaction

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

Specified by:

getLastDayCreated in interface ImmutableScheduledTransaction

Returns:

getMessage

public java.lang.String getMessage()

Description copied from interface: ImmutableScheduledTransaction

Returns the message associated with the scheduled transaction.

Specified by:

getMessage in interface ImmutableScheduledTransaction

Returns:

getScheduleDay

public int getScheduleDay()

Description copied from interface: ImmutableScheduledTransaction

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.

Specified by:

getScheduleDay in interface ImmutableScheduledTransaction

Returns:

getScheduleMonth

public int getScheduleMonth()

Description copied from interface: ImmutableScheduledTransaction

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.

Specified by:

getScheduleMonth in interface ImmutableScheduledTransaction

Returns:

getScheduleName

public java.lang.String getScheduleName()

Description copied from interface: ImmutableScheduledTransaction

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

Specified by:

getScheduleName in interface ImmutableScheduledTransaction

Returns:

getScheduleWeek

public int getScheduleWeek()

Description copied from interface: ImmutableScheduledTransaction

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.

Specified by:

getScheduleWeek in interface ImmutableScheduledTransaction

Returns:

getStartDate

public java.util.Date getStartDate()

Description copied from interface: ImmutableScheduledTransaction

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

Specified by:

getStartDate in interface ImmutableScheduledTransaction

Returns: