| java.lang.Object
 org.sakaiproject.calendar.impl.RecurrenceRuleBase
org.sakaiproject.calendar.impl.WeeklyRecurrenceRule
| WeeklyRecurrenceRule | | public class WeeklyRecurrenceRule extends RecurrenceRuleBase (Code) | | WeeklyRecurrenceRule is a time range generating rule that is based on a weekly recurrence.
The recurrences happen on the same day-of-week, at the same time as the prototype.
TODO: support changing the day-of-week of recurrences -ggolden
|
| Field Summary | |
| final protected static String | FREQ
The unique type / short frequency description. |
| Method Summary | |
| public String | getFrequencyDescription()
| | protected int | getRecurrenceType()
| | 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. |
| FREQ | | final protected static String FREQ(Code) | | The unique type / short frequency description.
|
| WeeklyRecurrenceRule | | public WeeklyRecurrenceRule()(Code) | | Construct.
|
| WeeklyRecurrenceRule | | public WeeklyRecurrenceRule(int interval)(Code) | | Construct with no limits.
Parameters:
interval - Every this many number of weeks: 1 would be weekly. |
| WeeklyRecurrenceRule | | public WeeklyRecurrenceRule(int interval, int count)(Code) | | Construct with count limit.
Parameters:
interval - Every this many number of weeks: 1 would be weekly.
Parameters:
count - For this many occurrences - if 0, does not limit. |
| WeeklyRecurrenceRule | | public WeeklyRecurrenceRule(int interval, Time until)(Code) | | Construct with time limit.
Parameters:
interval - Every this many number of weeks: 1 would be weekly.
Parameters:
until - No time ranges past this time are generated - if null, does not limit. |
| getFrequencyDescription | | public String getFrequencyDescription()(Code) | | |
| getRecurrenceType | | protected int getRecurrenceType()(Code) | | |
| 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. |
|
|