| org.sakaiproject.calendar.api.RecurrenceRule
All known Subclasses: org.sakaiproject.calendar.impl.ExclusionSeqRecurrenceRule, org.sakaiproject.calendar.impl.RecurrenceRuleBase, org.sakaiproject.calendar.impl.ExclusionRecurrenceRule,
| RecurrenceRule | | public interface RecurrenceRule (Code) | | RecurrenceRule is the interface for objects which add or remove multiple occurrences of timeranges.
|
| Method Summary | |
| void | excludeInstances(List ranges)
Remove from the ranges list any RecurrenceInstance excluded by this rule. | | 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. | | int | getCount()
Access the number of times that this event should repeat. | | String | getFrequencyDescription()
Access a short text describing the rule's frequency. | | int | getInterval()
Access the number of natural frequency units between repeats. | | Time | getUntil()
Access the end time for recurring events. | | void | set(Element el)
| | Element | toXml(Document doc, Stack stack)
Serialize the resource into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "resource" element. |
| excludeInstances | | void excludeInstances(List ranges)(Code) | | Remove from the ranges list any RecurrenceInstance excluded by this rule.
Parameters:
ranges - The list (RecurrenceInstance) of ranges. |
| generateInstances | | 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. a List of RecurrenceInstance generated by this rule in this range. |
| getCount | | int getCount()(Code) | | Access the number of times that this event should repeat.
The number of times that this event should repeat. |
| getFrequencyDescription | | String getFrequencyDescription()(Code) | | Access a short text describing the rule's frequency.
A frequency description. |
| getInterval | | int getInterval()(Code) | | Access the number of natural frequency units between repeats.
The number of natural frequency units between repeats. |
| getUntil | | Time getUntil()(Code) | | Access the end time for recurring events.
The end time for recurring events. |
| set | | void set(Element el)(Code) | | Take values from this xml element
Parameters:
el - The xml element. |
| toXml | | Element toXml(Document doc, Stack stack)(Code) | | Serialize the resource into XML, adding an element to the doc under the top of the stack element.
Parameters:
doc - The DOM doc to contain the XML (or null for a string return).
Parameters:
stack - The DOM elements, the top of which is the containing element of the new "resource" element. The newly added element. |
|
|