JavaScript is disabled on your browser.
public class RecurrenceRule
extends Object
Recurrence Rule Object
Field Summary
Fields
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Constructor Summary
Constructors
Creates a new RecurrenceRule object from a RecurrenceInfo entity.
Method Summary
All Methods Static Methods Instance Methods Concrete Methods
long
Get the number of times this recurrence will run (-1 until end time).
long
Gets the end time of the recurrence rule or 0 if none.
int
Returns the frequency of this recurrence.
Returns the frequency name of the recurrence.
long
Returns the interval of the frequency.
int
Returns the interval of the frequency as an int.
void
Initializes the rules for this RecurrenceInfo object.
boolean
isValid (long startTime,
long dateTime)
Tests the date to see if it falls within the rules
boolean
Tests the date to see if it falls within the rules
long
next (long startTime,
long fromTime,
long currentCount)
Returns the next recurrence of this rule.
void
Removes this rule from the persistant store.
long
validCurrent (long startTime,
long checkTime,
long currentCount)
Gets the current recurrence (current for the checkTime) of this rule and returns it if it is valid.
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
Field Details
MIN_SEC
public static final int MIN_SEC
See Also:
MAX_SEC
public static final int MAX_SEC
See Also:
MIN_MIN
public static final int MIN_MIN
See Also:
MAX_MIN
public static final int MAX_MIN
See Also:
MIN_HR
public static final int MIN_HR
See Also:
MAX_HR
public static final int MAX_HR
See Also:
MIN_MTH_DAY
public static final int MIN_MTH_DAY
See Also:
MAX_MTH_DAY
public static final int MAX_MTH_DAY
See Also:
MIN_YEAR_DAY
public static final int MIN_YEAR_DAY
See Also:
MAX_YEAR_DAY
public static final int MAX_YEAR_DAY
See Also:
MIN_WEEK_NO
public static final int MIN_WEEK_NO
See Also:
MAX_WEEK_NO
public static final int MAX_WEEK_NO
See Also:
MIN_MTH
public static final int MIN_MTH
See Also:
MAX_MTH
public static final int MAX_MTH
See Also:
SECONDLY
public static final int SECONDLY
Frequency SECONDLY
See Also:
MINUTELY
public static final int MINUTELY
Frequency MINUTELY
See Also:
HOURLY
public static final int HOURLY
Frequency HOURLY
See Also:
DAILY
public static final int DAILY
Frequency DAILY
See Also:
WEEKLY
public static final int WEEKLY
Frequency WEEKLY
See Also:
MONTHLY
public static final int MONTHLY
Frequency MONTHLY
See Also:
YEARLY
public static final int YEARLY
Frequency YEARLY
See Also:
Constructor Details
RecurrenceRule
Creates a new RecurrenceRule object from a RecurrenceInfo entity.
Parameters:
rule
- GenericValue object defining this rule.
Throws:
RecurrenceRuleException
Method Details
getEndTime
public long getEndTime ()
Gets the end time of the recurrence rule or 0 if none.
Returns:
long The timestamp of the end time for this rule or 0 for none.
getCount
public long getCount ()
Get the number of times this recurrence will run (-1 until end time).
Returns:
long The number of time this recurrence will run.
getFrequencyName
public String getFrequencyName ()
Returns the frequency name of the recurrence.
Returns:
String The name of this frequency.
getFrequency
public int getFrequency ()
Returns the frequency of this recurrence.
Returns:
int The reference value for the frequency
getInterval
public long getInterval ()
Returns the interval of the frequency.
Returns:
long Interval value
getIntervalInt
public int getIntervalInt ()
Returns the interval of the frequency as an int.
Returns:
The interval of this frequency as an integer.
next
public long next (long startTime,
long fromTime,
long currentCount)
Returns the next recurrence of this rule.
Parameters:
startTime
- The time this recurrence first began.
fromTime
- The time to base the next recurrence on.
currentCount
- The total number of times the recurrence has run.
Returns:
long The next recurrence as a long.
validCurrent
public long validCurrent (long startTime,
long checkTime,
long currentCount)
Gets the current recurrence (current for the checkTime) of this rule and returns it if it is valid.
If the current recurrence is not valid, doesn't try to find a valid one, instead returns 0.
Parameters:
startTime
- The time this recurrence first began.
checkTime
- The time to base the current recurrence on.
currentCount
- The total number of times the recurrence has run.
Returns:
long The current recurrence as long if valid. If next recurrence is not valid, returns 0.
isValid
public boolean isValid (Date startDate,
Date date)
Tests the date to see if it falls within the rules
Parameters:
startDate
- date object to test
Returns:
True if the date is within the rules
isValid
public boolean isValid (long startTime,
long dateTime)
Tests the date to see if it falls within the rules
Parameters:
startTime
- date object to test
Returns:
True if the date is within the rules
primaryKey
Primary key string.
Returns:
the string