| java.lang.Object
 org.sakaiproject.calendar.impl.ExclusionRecurrenceRule
| ExclusionRecurrenceRule | | public class ExclusionRecurrenceRule implements RecurrenceRule(Code) | | ExclusionRecurrenceRule is a rule which excludes specific time ranges from a list of instances.
|
| Field Summary | |
| protected List | m_ranges
The list of TimeRange values to exclude. |
| Method Summary | |
| 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. | | public int | getCount()
| | public String | getFrequencyDescription()
| | public int | getInterval()
| | public List | getRanges()
Access the List of TimeRange values excluded. | | public Time | getUntil()
| | public void | set(Element el)
| | public 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. |
| m_ranges | | protected List m_ranges(Code) | | The list of TimeRange values to exclude.
|
| ExclusionRecurrenceRule | | public ExclusionRecurrenceRule()(Code) | | Construct.
|
| ExclusionRecurrenceRule | | public ExclusionRecurrenceRule(List ranges)(Code) | | Construct with these limits.
Parameters:
ranges - The list of ranges to exclude |
| excludeInstances | | 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. a List of RecurrenceInstance generated by this rule in this range. |
| getCount | | public int getCount()(Code) | | |
| getFrequencyDescription | | public String getFrequencyDescription()(Code) | | |
| getInterval | | public int getInterval()(Code) | | |
| getRanges | | public List getRanges()(Code) | | Access the List of TimeRange values excluded.
the List of TimeRange values excluded. |
| set | | public void set(Element el)(Code) | | Take values from this xml element
Parameters:
el - The xml element. |
| toXml | | public 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. |
|
|