org.homeunix.thecave.buddi.model
Interface ScheduledTransaction

All Superinterfaces:

java.lang.Comparable<ModelObject>, ModelObject, Transaction

All Known Implementing Classes:

ScheduledTransactionImpl

public interface ScheduledTransaction
extends Transaction

Author:

wyatt

Method Summary

java.util.Date	getEndDate() Returns the end date
java.lang.String	getFrequencyType() Sets the frequency type
java.util.Date	getLastDayCreated() Gets the last day on which a transaction was created.
java.lang.String	getMessage() Returns the message with this scheduled transaction.
int	getScheduleDay() Returns the scheduled day.
int	getScheduleMonth() Returns the scheduled month.
java.lang.String	getScheduleName() Returns the name of this scheduled transaction.
int	getScheduleWeek() Returns the scheduled week.
java.util.Date	getStartDate() Returns the date on which this scheduled transaction is to start.
void	setEndDate(java.util.Date endDate) Sets the end date for this scheduled transaction.
void	setFrequencyType(java.lang.String frequencyType) Sets the frequency type for this scheduled transaction.
void	setLastDayCreated(java.util.Date lastDayCreated) Sets the last day created.
void	setMessage(java.lang.String message) Sets the message
void	setScheduleDay(int scheduleDay) Sets the schedule day.
void	setScheduleMonth(int scheduleMonth) Sets the schedule month.
void	setScheduleName(java.lang.String scheduleName) Sets the scheduled transaction name
void	setScheduleWeek(int scheduleWeek) Sets the schedule week.
void	setStartDate(java.util.Date startDate) Sets the start date for this scheduled transaction.

Methods inherited from interface org.homeunix.thecave.buddi.model.Transaction

getAmount, getBalanceFrom, getBalanceTo, getDate, getDescription, getFrom, getMemo, getNumber, getTo, isClearedFrom, isClearedTo, isDeleted, isInflow, isReconciledFrom, isReconciledTo, isScheduled, setAmount, setBalanceFrom, setBalanceTo, setClearedFrom, setClearedTo, setDate, setDeleted, setDescription, setFrom, setMemo, setNumber, setReconciledFrom, setReconciledTo, setScheduled, setTo

Methods inherited from interface org.homeunix.thecave.buddi.model.ModelObject

compareTo, getDocument, getModified, getUid, setChanged, setDocument

Method Detail

getEndDate

java.util.Date getEndDate()

Returns the end date

Returns:

getFrequencyType

java.lang.String getFrequencyType()

Sets the frequency type

Returns:

getLastDayCreated

java.util.Date getLastDayCreated()

Gets the last day on which a transaction was created. If there have been no transactions created from this schedule yet, return null.

Returns:

getMessage

java.lang.String getMessage()

Returns the message with this scheduled transaction.

Returns:

getScheduleDay

int getScheduleDay()

Returns the scheduled day. This may have different meanings depending on the frequency type.

Returns:

getScheduleMonth

int getScheduleMonth()

Returns the scheduled month. This may have different meanings depending on the frequency type.

Returns:

getScheduleName

java.lang.String getScheduleName()

Returns the name of this scheduled transaction. This is the name which shows up in the main scheduled transaction list.

Returns:

getScheduleWeek

int getScheduleWeek()

Returns the scheduled week. This may have different meanings depending on the frequency type.

Returns:

getStartDate

java.util.Date getStartDate()

Returns the date on which this scheduled transaction is to start.

Returns:

setEndDate

void setEndDate(java.util.Date endDate)
                throws InvalidValueException

Sets the end date for this scheduled transaction.

Parameters:

endDate -

Throws:

InvalidValueException

setFrequencyType

void setFrequencyType(java.lang.String frequencyType)
                      throws InvalidValueException

Sets the frequency type for this scheduled transaction. This must be the string representation of one of the ScheduleFrequency enum values.

Parameters:

frequencyType -

Throws:

InvalidValueException

setLastDayCreated

void setLastDayCreated(java.util.Date lastDayCreated)
                       throws InvalidValueException

Sets the last day created. This is used to keep track of where we left off with the last scheduled transaction, to avoid duplicates and keep the time needed to run schedule checks to a minimum.

Parameters:

lastDayCreated -

Throws:

InvalidValueException

setMessage

void setMessage(java.lang.String message)
                throws InvalidValueException

Sets the message

Parameters:

message -

Throws:

InvalidValueException

setScheduleDay

void setScheduleDay(int scheduleDay)
                    throws InvalidValueException

Sets the schedule day. This has different meanings based on the schedule frequency.

Parameters:

scheduleDay -

Throws:

InvalidValueException

setScheduleMonth

void setScheduleMonth(int scheduleMonth)
                      throws InvalidValueException

Sets the schedule month. This has different meanings based on the schedule frequency.

Parameters:

scheduleMonth -

Throws:

InvalidValueException

setScheduleName

void setScheduleName(java.lang.String scheduleName)
                     throws InvalidValueException

Sets the scheduled transaction name

Parameters:

scheduleName -

Throws:

InvalidValueException

setScheduleWeek

void setScheduleWeek(int scheduleWeek)
                     throws InvalidValueException

Sets the schedule week. This has different meanings based on the schedule frequency.

Parameters:

scheduleWeek -

Throws:

InvalidValueException

setStartDate

void setStartDate(java.util.Date startDate)
                  throws InvalidValueException

Sets the start date for this scheduled transaction.

Parameters:

startDate -

Throws:

InvalidValueException