| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| ImmutableScheduledTransaction |
|
| 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.model.ScheduledTransaction; | |
| 9 | ||
| 10 | public interface ImmutableScheduledTransaction extends ImmutableTransaction { | |
| 11 | ||
| 12 | /** | |
| 13 | * Returns the wrapped object from the underlying data model. By | |
| 14 | * accessing this method, you bypass all protection which the Buddi API | |
| 15 | * gives you; it is not recommended to use this method unless you understand | |
| 16 | * the risks associated with it. | |
| 17 | * @return | |
| 18 | */ | |
| 19 | public ScheduledTransaction getScheduledTransaction(); | |
| 20 | ||
| 21 | /** | |
| 22 | * Returns the end date of the scheduled transaction. After this date, | |
| 23 | * the transaction is no longer active (although it stays in the list). | |
| 24 | * As of August 31 2007, this method is not used, but is here for | |
| 25 | * a future release which will support it. | |
| 26 | * @return | |
| 27 | */ | |
| 28 | public Date getEndDate(); | |
| 29 | ||
| 30 | /** | |
| 31 | * Returns the frequncy type. This is a string representation of | |
| 32 | * one of the ScheduleFrequency enum values. | |
| 33 | * @return | |
| 34 | */ | |
| 35 | public String getFrequencyType(); | |
| 36 | ||
| 37 | /** | |
| 38 | * Returns the last day which this scheduled transaction was used on. This | |
| 39 | * is used to determine where to start looking for the next iteration. | |
| 40 | * @return | |
| 41 | */ | |
| 42 | public Date getLastDayCreated(); | |
| 43 | ||
| 44 | /** | |
| 45 | * Returns the message associated with the scheduled transaction. | |
| 46 | * @return | |
| 47 | */ | |
| 48 | public String getMessage(); | |
| 49 | ||
| 50 | /** | |
| 51 | * Returns an integer representation of the scheduled transaction day. Depending | |
| 52 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 53 | * not be used at all. | |
| 54 | * @return | |
| 55 | */ | |
| 56 | public int getScheduleDay(); | |
| 57 | /** | |
| 58 | * Returns an integer representation of the scheduled transaction month. Depending | |
| 59 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 60 | * not be used at all. | |
| 61 | * @return | |
| 62 | */ | |
| 63 | public int getScheduleMonth(); | |
| 64 | ||
| 65 | /** | |
| 66 | * Returns the name of this scheduled transaction. This is the name | |
| 67 | * which will appear in the list of scheduled transactions. | |
| 68 | * @return | |
| 69 | */ | |
| 70 | public String getScheduleName(); | |
| 71 | ||
| 72 | /** | |
| 73 | * Returns an integer representation of the scheduled transaction week. Depending | |
| 74 | * on the value of getFrequencyType(), this value may mean different things, or may | |
| 75 | * not be used at all. | |
| 76 | * @return | |
| 77 | */ | |
| 78 | public int getScheduleWeek(); | |
| 79 | ||
| 80 | /** | |
| 81 | * Returns the starting day of this scheduled transaction. No transactions | |
| 82 | * will be added before this date. | |
| 83 | * @return | |
| 84 | */ | |
| 85 | public Date getStartDate(); | |
| 86 | } |