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

All Superinterfaces:

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

All Known Implementing Classes:

MutableScheduledTransactionImpl

public interface MutableScheduledTransaction
extends MutableTransaction, ImmutableScheduledTransaction

Method Summary

void	setEndDate(java.util.Date endDate) Sets the end date of the scheduled transaction.
void	setFrequencyType(java.lang.String frequencyType) Sets the frequncy type.
void	setLastDayCreated(java.util.Date lastDayCreated) Sets the last day which this scheduled transaction was used on.
void	setMessage(java.lang.String message) Sets the message associated with the scheduled transaction.
void	setScheduleDay(int scheduleDay) Sets an integer representation of the scheduled transaction day.
void	setScheduleMonth(int scheduleMonth) Sets an integer representation of the scheduled transaction month.
void	setScheduleName(java.lang.String scheduleName) Sets the name of this scheduled transaction.
void	setScheduleWeek(int scheduleWeek) Sets an integer representation of the scheduled transaction week.
void	setStartDate(java.util.Date startDate) Returns the starting day of this scheduled transaction.

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

getFrom, getTo, setAmount, setClearedFrom, setClearedTo, setDate, setDeleted, setDescription, setFrom, setMemo, setNumber, setReconciledFrom, setReconciledTo, setScheduled, setTo

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

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

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

getEndDate, getFrequencyType, getLastDayCreated, getMessage, getScheduleDay, getScheduledTransaction, getScheduleMonth, getScheduleName, getScheduleWeek, getStartDate

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

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

setEndDate

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

Sets 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.

Parameters:

endDate -

Throws:

InvalidValueException

setFrequencyType

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

Sets the frequncy type. This is a 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 which this scheduled transaction was used on. This is used to determine where to start looking for the next iteration.

Parameters:

lastDayCreated -

Throws:

InvalidValueException

setMessage

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

Sets the message associated with the scheduled transaction.

Parameters:

message -

Throws:

InvalidValueException

setScheduleDay

void setScheduleDay(int scheduleDay)
                    throws InvalidValueException

Sets 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.

Parameters:

scheduleDay -

Throws:

InvalidValueException

setScheduleMonth

void setScheduleMonth(int scheduleMonth)
                      throws InvalidValueException

Sets 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.

Parameters:

scheduleMonth -

Throws:

InvalidValueException

setScheduleName

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

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

Parameters:

scheduleName -

Throws:

InvalidValueException

setScheduleWeek

void setScheduleWeek(int scheduleWeek)
                     throws InvalidValueException

Sets 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.

Parameters:

scheduleWeek -

Throws:

InvalidValueException

setStartDate

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

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

Parameters:

startDate -

Throws:

InvalidValueException