| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| MutableScheduledTransaction |
|
| 1.0;1 |
| 1 | /* | |
| 2 | * Created on Aug 26, 2007 by wyatt | |
| 3 | */ | |
| 4 | package org.homeunix.thecave.buddi.plugin.api.model; | |
| 5 | ||
| 6 | import java.util.Date; | |
| 7 | ||
| 8 | import org.homeunix.thecave.buddi.plugin.api.exception.InvalidValueException; | |
| 9 | ||
| 10 | public interface MutableScheduledTransaction extends MutableTransaction, ImmutableScheduledTransaction { | |
| 11 | /** | |
| 12 | * Sets the end date of the scheduled transaction. After this date, | |
| 13 | * the transaction is no longer active (although it stays in the list). | |
| 14 | * As of August 31 2007, this method is not used, but is here for | |
| 15 | * a future release which will support it. | |
| 16 | * @param endDate | |
| 17 | * @throws InvalidValueException | |
| 18 | */ | |
| 19 | public void setEndDate(Date endDate) throws InvalidValueException; | |
| 20 | ||
| 21 | /** | |
| 22 | * Sets the frequncy type. This is a string representation of | |
| 23 | * one of the ScheduleFrequency enum values. | |
| 24 | * @param frequencyType | |
| 25 | * @throws InvalidValueException | |
| 26 | */ | |
| 27 | public void setFrequencyType(String frequencyType) throws InvalidValueException; | |
| 28 | ||
| 29 | /** | |
| 30 | * Sets the last day which this scheduled transaction was used on. This | |
| 31 | * is used to determine where to start looking for the next iteration. | |
| 32 | * @param lastDayCreated | |
| 33 | * @throws InvalidValueException | |
| 34 | */ | |
| 35 | public void setLastDayCreated(Date lastDayCreated) throws InvalidValueException; | |
| 36 | ||
| 37 | /** | |
| 38 | * Sets the message associated with the scheduled transaction. | |
| 39 | * @param message | |
| 40 | * @throws InvalidValueException | |
| 41 | */ | |
| 42 | public void setMessage(String message) throws InvalidValueException; | |
| 43 | ||
| 44 | /** | |
| 45 | * Sets an integer representation of the scheduled transaction day. Depending | |
| 46 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 47 | * not be used at all. | |
| 48 | * @param scheduleDay | |
| 49 | * @throws InvalidValueException | |
| 50 | */ | |
| 51 | public void setScheduleDay(int scheduleDay) throws InvalidValueException; | |
| 52 | ||
| 53 | /** | |
| 54 | * Sets an integer representation of the scheduled transaction month. Depending | |
| 55 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 56 | * not be used at all. | |
| 57 | * @param scheduleMonth | |
| 58 | * @throws InvalidValueException | |
| 59 | */ | |
| 60 | public void setScheduleMonth(int scheduleMonth) throws InvalidValueException; | |
| 61 | ||
| 62 | /** | |
| 63 | * Sets the name of this scheduled transaction. This is the name | |
| 64 | * which will appear in the list of scheduled transactions. | |
| 65 | * @param scheduleName | |
| 66 | * @throws InvalidValueException | |
| 67 | */ | |
| 68 | public void setScheduleName(String scheduleName) throws InvalidValueException; | |
| 69 | ||
| 70 | /** | |
| 71 | * Sets an integer representation of the scheduled transaction week. Depending | |
| 72 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 73 | * not be used at all. | |
| 74 | * @param scheduleWeek | |
| 75 | * @throws InvalidValueException | |
| 76 | */ | |
| 77 | public void setScheduleWeek(int scheduleWeek) throws InvalidValueException; | |
| 78 | ||
| 79 | /** | |
| 80 | * Returns the starting day of this scheduled transaction. No transactions | |
| 81 | * will be added before this date. | |
| 82 | * @param startDate | |
| 83 | * @throws InvalidValueException | |
| 84 | */ | |
| 85 | public void setStartDate(Date startDate) throws InvalidValueException; | |
| 86 | } |