| java.lang.Object
 org.sakaiproject.calendar.impl.RecurrenceRuleBase
All known Subclasses: org.sakaiproject.calendar.impl.MonthlyRecurrenceRule, org.sakaiproject.calendar.impl.YearlyRecurrenceRule, org.sakaiproject.calendar.impl.WeeklyRecurrenceRule, org.sakaiproject.calendar.impl.DailyRecurrenceRule,
| RecurrenceRuleBase | | abstract public class RecurrenceRuleBase implements RecurrenceRule(Code) | | This is a common base for the daily, weekly, monthly, and yearly recurrence rules.
|
| Method Summary | |
| final public void | excludeInstances(List ranges)
Remove from the ranges list any RecurrenceInstance excluded by this rule. | | public List | generateInstances(TimeRange prototype, TimeRange range, TimeZone timeZone)
Return a List of all RecurrenceInstance objects generated by this rule within the given time range, based on the
prototype first range, in time order.
Parameters:
prototype - The prototype first TimeRange.
Parameters:
range - A time range to limit the generated ranges.
Parameters:
timeZone - The time zone to use for displaying times.%%% Note: this is currently not implemented, and always uses the "local" zone. | | final public int | getCount()
Gets the number of times (years) that this event should repeat. | | final public int | getInterval()
Gets the interval (in years) for this event. | | abstract protected int | getRecurrenceType()
| | final public Time | getUntil()
Gets the end time for recurring events. | | final protected boolean | isAfter(Time time1, Time time2)
| | final protected boolean | isOverlap(TimeRange range1, TimeRange range2)
Checks for overlap. | | public void | set(Element el)
| | protected void | setBaseClassXML(Element rule)
Set base class attributes in the Element rule during XML serialization. | | final protected void | setCount(int i)
Sets the number of times that this event will repeat. | | final protected void | setInterval(int i)
Sets the interval (in months) which this event will repeat. | | final protected void | setUntil(Time time)
Sets the end time for this recurring event. |
| RecurrenceRuleBase | | public RecurrenceRuleBase()(Code) | | Construct.
|
| RecurrenceRuleBase | | public RecurrenceRuleBase(int interval)(Code) | | Construct with no limits.
Parameters:
interval - Every this many number of days: 1 would be daily. |
| RecurrenceRuleBase | | public RecurrenceRuleBase(int interval, int count)(Code) | | Construct with count limit.
Parameters:
interval - Every this many number of days: 1 would be daily.
Parameters:
count - For this many occurrences - if 0, does not limit. |
| RecurrenceRuleBase | | public RecurrenceRuleBase(int interval, Time until)(Code) | | Construct with time limit.
Parameters:
interval - Every this many number of days: 1 would be daily.
Parameters:
until - No time ranges past this time are generated - if null, does not limit. |
| excludeInstances | | final public void excludeInstances(List ranges)(Code) | | Remove from the ranges list any RecurrenceInstance excluded by this rule.
Parameters:
ranges - The list (RecurrenceInstance) of ranges. |
| generateInstances | | public List generateInstances(TimeRange prototype, TimeRange range, TimeZone timeZone)(Code) | | Return a List of all RecurrenceInstance objects generated by this rule within the given time range, based on the
prototype first range, in time order.
Parameters:
prototype - The prototype first TimeRange.
Parameters:
range - A time range to limit the generated ranges.
Parameters:
timeZone - The time zone to use for displaying times.%%% Note: this is currently not implemented, and always uses the "local" zone. a List of RecurrenceInstance generated by this rule in this range. |
| getCount | | final public int getCount()(Code) | | Gets the number of times (years) that this event should repeat.
|
| getInterval | | final public int getInterval()(Code) | | Gets the interval (in years) for this event.
|
| getRecurrenceType | | abstract protected int getRecurrenceType()(Code) | | |
| getUntil | | final public Time getUntil()(Code) | | Gets the end time for recurring events.
|
| isAfter | | final protected boolean isAfter(Time time1, Time time2)(Code) | | Returns true if time1 is after time2
Parameters:
time1 -
Parameters:
time2 - |
| isOverlap | | final protected boolean isOverlap(TimeRange range1, TimeRange range2)(Code) | | Checks for overlap.
Parameters:
range1 -
Parameters:
range2 - |
| set | | public void set(Element el)(Code) | | Take values from this xml element
Parameters:
el - The xml element. |
| setBaseClassXML | | protected void setBaseClassXML(Element rule)(Code) | | Set base class attributes in the Element rule during XML serialization.
Parameters:
rule - |
| setCount | | final protected void setCount(int i)(Code) | | Sets the number of times that this event will repeat. This object is immutable, but we need
the "set" method for unit testing.
Parameters:
i - |
| setInterval | | final protected void setInterval(int i)(Code) | | Sets the interval (in months) which this event will repeat. This object is immutable, but we need
the "set" method for unit testing.
Parameters:
i - |
| setUntil | | final protected void setUntil(Time time)(Code) | | Sets the end time for this recurring event. This object is immutable, but we need
the "set" method for unit testing.
Parameters:
time - |
|
|