| java.lang.Object
 org.ofbiz.service.calendar.RecurrenceRule
| RecurrenceRule | | public class RecurrenceRule (Code) | | Recurrence Rule Object
author:
Andy Zeneski
version:
$Revision: 1.5 $
since:
2.0 |
| Method Summary | |
| public long | getCount()
Get the number of times this recurrence will run (-1 until end time). | | public long | getEndTime()
Gets the end time of the recurrence rule or 0 if none. | | public int | getFrequency()
Returns the frequency of this recurrence. | | public String | getFrequencyName()
Returns the frequency name of the recurrence. | | public long | getInterval()
Returns the interval of the frequency. | | public int | getIntervalInt()
Returns the interval of the frequency as an int. | | public void | init()
Initializes the rules for this RecurrenceInfo object. | | public boolean | isValid(Date startDate, Date date)
| | public boolean | isValid(long startTime, long dateTime)
| | public static RecurrenceRule | makeRule(GenericDelegator delegator, int frequency, int interval, int count)
| | public static RecurrenceRule | makeRule(GenericDelegator delegator, int frequency, int interval, long endTime)
| | public static RecurrenceRule | makeRule(GenericDelegator delegator, int frequency, int interval, int count, long endTime)
| | public long | next(long startTime, long fromTime, long currentCount)
Returns the next recurrence of this rule.
Parameters:
startTime - The time this recurrence first began.
Parameters:
fromTime - The time to base the next recurrence on.
Parameters:
currentCount - The total number of times the recurrence has run. | | public String | primaryKey()
| | public void | remove()
Removes this rule from the persistant store. |
| DAILY | | final public static int DAILY(Code) | | Frequency DAILY
|
| HOURLY | | final public static int HOURLY(Code) | | Frequency HOURLY
|
| MAX_HR | | final public static int MAX_HR(Code) | | |
| MAX_MIN | | final public static int MAX_MIN(Code) | | |
| MAX_MTH | | final public static int MAX_MTH(Code) | | |
| MAX_MTH_DAY | | final public static int MAX_MTH_DAY(Code) | | |
| MAX_SEC | | final public static int MAX_SEC(Code) | | |
| MAX_WEEK_NO | | final public static int MAX_WEEK_NO(Code) | | |
| MAX_YEAR_DAY | | final public static int MAX_YEAR_DAY(Code) | | |
| MINUTELY | | final public static int MINUTELY(Code) | | Frequency MINUTELY
|
| MIN_HR | | final public static int MIN_HR(Code) | | |
| MIN_MIN | | final public static int MIN_MIN(Code) | | |
| MIN_MTH | | final public static int MIN_MTH(Code) | | |
| MIN_MTH_DAY | | final public static int MIN_MTH_DAY(Code) | | |
| MIN_SEC | | final public static int MIN_SEC(Code) | | |
| MIN_WEEK_NO | | final public static int MIN_WEEK_NO(Code) | | |
| MIN_YEAR_DAY | | final public static int MIN_YEAR_DAY(Code) | | |
| MONTHLY | | final public static int MONTHLY(Code) | | Frequency MONTHLY
|
| SECONDLY | | final public static int SECONDLY(Code) | | Frequency SECONDLY
|
| WEEKLY | | final public static int WEEKLY(Code) | | Frequency WEEKLY
|
| YEARLY | | final public static int YEARLY(Code) | | Frequency YEARLY
|
| RecurrenceRule | | public RecurrenceRule(GenericValue rule) throws RecurrenceRuleException(Code) | | Creates a new RecurrenceRule object from a RecurrenceInfo entity.
Parameters:
rule - GenericValue object defining this rule. |
| getCount | | public long getCount()(Code) | | Get the number of times this recurrence will run (-1 until end time).
long The number of time this recurrence will run. |
| getEndTime | | public long getEndTime()(Code) | | Gets the end time of the recurrence rule or 0 if none.
long The timestamp of the end time for this rule or 0 for none. |
| getFrequency | | public int getFrequency()(Code) | | Returns the frequency of this recurrence.
int The reference value for the frequency |
| getFrequencyName | | public String getFrequencyName()(Code) | | Returns the frequency name of the recurrence.
String The name of this frequency. |
| getInterval | | public long getInterval()(Code) | | Returns the interval of the frequency.
long Interval value |
| getIntervalInt | | public int getIntervalInt()(Code) | | Returns the interval of the frequency as an int.
The interval of this frequency as an integer. |
| isValid | | public boolean isValid(Date startDate, Date date)(Code) | | Tests the date to see if it falls within the rules
Parameters:
startDate - date object to test True if the date is within the rules |
| isValid | | public boolean isValid(long startTime, long dateTime)(Code) | | Tests the date to see if it falls within the rules
Parameters:
startTime - date object to test True if the date is within the rules |
| next | | public long next(long startTime, long fromTime, long currentCount)(Code) | | Returns the next recurrence of this rule.
Parameters:
startTime - The time this recurrence first began.
Parameters:
fromTime - The time to base the next recurrence on.
Parameters:
currentCount - The total number of times the recurrence has run. long The next recurrence as a long. |
|
|