Coverage Report

Coverage Report - org.homeunix.thecave.buddi.model.ScheduledTransaction

Classes in this File

 /*
  * Created on Jul 30, 2007 by wyatt
  */
 package org.homeunix.thecave.buddi.model;
 
 import java.util.Date;
 
 import org.homeunix.thecave.buddi.plugin.api.exception.InvalidValueException;
 
 /**
  * @author wyatt
  *
  */
 public interface ScheduledTransaction extends Transaction {
 
         /**
          * Returns the end date
          * @return
          */
         public Date getEndDate();
         
         /**
          * Sets the frequency type
          * @return
          */
         public String getFrequencyType();
         
         /**
          * Gets the last day on which a transaction was created.  If there have been
          * no transactions created from this schedule yet, return null.
          * @return
          */
         public Date getLastDayCreated();
         
         /**
          * Returns the message with this scheduled transaction.
          * @return
          */
         public String getMessage();
         
         /**
          * Returns the scheduled day.  This may have different meanings depending on the 
          * frequency type.
          * @return
          */
         public int getScheduleDay();
         
         /**
          * Returns the scheduled month.  This may have different meanings depending on the
          *frequency type.
          * @return
          */
         public int getScheduleMonth();
         
         /**
          * Returns the name of this scheduled transaction.  This is the name which shows up
          * in the main scheduled transaction list.
          * @return
          */
         public String getScheduleName();
         
         /**
          * Returns the scheduled week.  This may have different meanings depending on the
          * frequency type.
          * @return
          */
         public int getScheduleWeek();
         
         /**
          * Returns the date on which this scheduled transaction is to start. 
          * @return
          */
         public Date getStartDate();
         
         /**
          * Sets the end date for this scheduled transaction.
          * @param endDate
          * @throws InvalidValueException
          */
         public void setEndDate(Date endDate) throws InvalidValueException;
         
         /**
          * Sets the frequency type for this scheduled transaction.  This must
          * be the string representation of one of the ScheduleFrequency enum
          * values.
          * @param frequencyType
          * @throws InvalidValueException
          */
         public void setFrequencyType(String frequencyType) 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.
          * @param lastDayCreated
          * @throws InvalidValueException
          */
         public void setLastDayCreated(Date lastDayCreated) throws InvalidValueException;
         
         /**
          * Sets the message
          * @param message
          * @throws InvalidValueException
          */
         public void setMessage(String message) throws InvalidValueException;
         
         /**
          * Sets the schedule day.  This has different meanings based on the schedule frequency.
          * @param scheduleDay
          * @throws InvalidValueException
          */
         public void setScheduleDay(int scheduleDay) throws InvalidValueException;
         
         /**
          * Sets the schedule month.  This has different meanings based on the schedule frequency.
          * @param scheduleMonth
          * @throws InvalidValueException
          */
         public void setScheduleMonth(int scheduleMonth) throws InvalidValueException;
         
         /**
          * Sets the scheduled transaction name
          * @param scheduleName
          * @throws InvalidValueException
          */
         public void setScheduleName(String scheduleName) throws InvalidValueException;
         
         /**
          * Sets the schedule week.  This has different meanings based on the schedule frequency.
          * @param scheduleWeek
          * @throws InvalidValueException
          */
         public void setScheduleWeek(int scheduleWeek) throws InvalidValueException;
         
         /**
          * Sets the start date for this scheduled transaction.
          * @param startDate
          * @throws InvalidValueException
          */
         public void setStartDate(Date startDate) throws InvalidValueException;
 }

1		/*
2		* Created on Jul 30, 2007 by wyatt
3		*/
4		package org.homeunix.thecave.buddi.model;
5
6		import java.util.Date;
7
8		import org.homeunix.thecave.buddi.plugin.api.exception.InvalidValueException;
9
10		/**
11		* @author wyatt
12		*
13		*/
14		public interface ScheduledTransaction extends Transaction {
15
16		/**
17		* Returns the end date
18		* @return
19		*/
20		public Date getEndDate();
21
22		/**
23		* Sets the frequency type
24		* @return
25		*/
26		public String getFrequencyType();
27
28		/**
29		* Gets the last day on which a transaction was created. If there have been
30		* no transactions created from this schedule yet, return null.
31		* @return
32		*/
33		public Date getLastDayCreated();
34
35		/**
36		* Returns the message with this scheduled transaction.
37		* @return
38		*/
39		public String getMessage();
40
41		/**
42		* Returns the scheduled day. This may have different meanings depending on the
43		* frequency type.
44		* @return
45		*/
46		public int getScheduleDay();
47
48		/**
49		* Returns the scheduled month. This may have different meanings depending on the
50		*frequency type.
51		* @return
52		*/
53		public int getScheduleMonth();
54
55		/**
56		* Returns the name of this scheduled transaction. This is the name which shows up
57		* in the main scheduled transaction list.
58		* @return
59		*/
60		public String getScheduleName();
61
62		/**
63		* Returns the scheduled week. This may have different meanings depending on the
64		* frequency type.
65		* @return
66		*/
67		public int getScheduleWeek();
68
69		/**
70		* Returns the date on which this scheduled transaction is to start.
71		* @return
72		*/
73		public Date getStartDate();
74
75		/**
76		* Sets the end date for this scheduled transaction.
77		* @param endDate
78		* @throws InvalidValueException
79		*/
80		public void setEndDate(Date endDate) throws InvalidValueException;
81
82		/**
83		* Sets the frequency type for this scheduled transaction. This must
84		* be the string representation of one of the ScheduleFrequency enum
85		* values.
86		* @param frequencyType
87		* @throws InvalidValueException
88		*/
89		public void setFrequencyType(String frequencyType) throws InvalidValueException;
90
91		/**
92		* Sets the last day created. This is used to keep track of where we left
93		* off with the last scheduled transaction, to avoid duplicates and keep
94		* the time needed to run schedule checks to a minimum.
95		* @param lastDayCreated
96		* @throws InvalidValueException
97		*/
98		public void setLastDayCreated(Date lastDayCreated) throws InvalidValueException;
99
100		/**
101		* Sets the message
102		* @param message
103		* @throws InvalidValueException
104		*/
105		public void setMessage(String message) throws InvalidValueException;
106
107		/**
108		* Sets the schedule day. This has different meanings based on the schedule frequency.
109		* @param scheduleDay
110		* @throws InvalidValueException
111		*/
112		public void setScheduleDay(int scheduleDay) throws InvalidValueException;
113
114		/**
115		* Sets the schedule month. This has different meanings based on the schedule frequency.
116		* @param scheduleMonth
117		* @throws InvalidValueException
118		*/
119		public void setScheduleMonth(int scheduleMonth) throws InvalidValueException;
120
121		/**
122		* Sets the scheduled transaction name
123		* @param scheduleName
124		* @throws InvalidValueException
125		*/
126		public void setScheduleName(String scheduleName) throws InvalidValueException;
127
128		/**
129		* Sets the schedule week. This has different meanings based on the schedule frequency.
130		* @param scheduleWeek
131		* @throws InvalidValueException
132		*/
133		public void setScheduleWeek(int scheduleWeek) throws InvalidValueException;
134
135		/**
136		* Sets the start date for this scheduled transaction.
137		* @param startDate
138		* @throws InvalidValueException
139		*/
140		public void setStartDate(Date startDate) throws InvalidValueException;
141		}