com.telerik.widget.calendar.events.read

Class RecurringEvent

java.lang.Object

com.telerik.widget.calendar.events.Event

com.telerik.widget.calendar.events.read.RecurringEvent

public class RecurringEvent
extends Event

Recurring event holds all the information about a recurring rule bound to a recurring event.

Constructor Summary

Constructors

Constructor and Description
RecurringEvent(String title, long startDate, long endDate, String rrule) Creates a new instance of the RecurringEvent class for storing information about the recurrence rule of a recurring event.
RecurringEvent(String title, long startDate, String duration, String rrule) Creates a new instance of the RecurringEvent class for storing information about the recurrence rule of a recurring event.

Method Summary

Modifier and Type	Method and Description
boolean	byDay(int day) Used to check if a given day is present in the by day set.
int	byDayModifier(int day) Gets the corresponding day modifier for the given day.
int[]	byHour() The collection of hours for the recurrence rule.
int[]	byMinute() The collection of minutes for the recurrence rule.
boolean	byMonth(int month) Used to check if a given month is present in the by month set.
int[]	byMonthDay() The collection of month days for the recurrence rule.
int[]	bySecond() The collection of seconds for the recurrence rule.
int[]	bySetPos() Gets the BYSETPOS values for the recurrance.
int[]	byWeekNo() The collection of week numbers for the recurrence rule.
int[]	byYearDay() The collection of year days for the recurrence rule.
int	count() Gets the count used in repeating the event.
Frequency	frequency() Gets the frequency at which the rule recurs.
int	interval() Gets the interval in which the recurrence occurs.
boolean	isByDay() Gets a value determining whether the rule is stated as byday rule.
boolean	isByDayModified() Gets a value determining whether the BYDAY rule is modified such as in -1MO.
boolean	isByHour() Gets a value stating whether the rule has defined byHour values.
boolean	isByMinute() Gets a value stating whether the rule has defined byMinute values.
boolean	isByMonth() Gets a value determining whether the rule is stated as byMonth rule.
boolean	isByMonthDay() Gets a value stating whether the rule has defined byMonthDay values.
boolean	isBySecond() Gets a value stating whether the rule has defined bySecond values.
boolean	isBySetPos() Gets a value stating whether the rule has defined bySetPos values.
boolean	isByWeekNo() Gets a value stating whether the rule has defined byWeekNo values.
boolean	isByYearDay() Gets a value stating whether the rule has defined byYearDay values.
boolean	isModified() Gets a value determining whether the rule is being modified using additional nth ocurrence rule as in -2MO or in BYSETPOS=-1.
long	repeatUntilDate() Gets the repeat until date if present.
String	rrule() Gets the recurrence rule used to build the current event instance tokens.
int	weekStartDay() Gets the start of the week for this event.

Methods inherited from class com.telerik.widget.calendar.events.Event

getCalendarId, getDetails, getEndDate, getEventColor, getStartDate, getTitle, isAllDay, setAllDay, setCalendarId, setDetails, setEndDate, setEventColor, setStartDate, setTitle

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RecurringEvent

public RecurringEvent(String title,
                      long startDate,
                      String duration,
                      String rrule)

Creates a new instance of the RecurringEvent class for storing information about the recurrence rule of a recurring event.

Parameters:

title - the title of the event.

startDate - the start date of the event.

duration - duration of the event expressed as the [ISO 8601] basic format for the duration of time.

rrule - the rrule holding the recurrence information.

RecurringEvent

public RecurringEvent(String title,
                      long startDate,
                      long endDate,
                      String rrule)

Creates a new instance of the RecurringEvent class for storing information about the recurrence rule of a recurring event.

Parameters:

title - the title of the event.

startDate - the start date of the event.

endDate - the end date of the event.

rrule - the rrule holding the recurrence information.

Method Detail

byDayModifier

public int byDayModifier(int day)

Gets the corresponding day modifier for the given day. Valid values are Calendar.SUNDAY, Calendar.MONDAY etc. Default value is 0.

Parameters:

day - the day for which to check in the modifiers.

Returns:

the modifier for this day.

bySecond

public int[] bySecond()

The collection of seconds for the recurrence rule. Default value is null.

Returns:

the current collection of seconds.

byMinute

public int[] byMinute()

The collection of minutes for the recurrence rule. Default value is null.

Returns:

the current collection of minutes.

byHour

public int[] byHour()

The collection of hours for the recurrence rule. Default value is null.

Returns:

the current collection of hours.

byMonthDay

public int[] byMonthDay()

The collection of month days for the recurrence rule. Default value is null.

Returns:

the current collection of month days.

byYearDay

public int[] byYearDay()

The collection of year days for the recurrence rule. Default value is null.

Returns:

the current collection of year days.

byWeekNo

public int[] byWeekNo()

The collection of week numbers for the recurrence rule. Default value is null.

Returns:

the current collection of week numbers.

rrule

public String rrule()

Gets the recurrence rule used to build the current event instance tokens.

Returns:

the current recurrence rule.

byDay

public boolean byDay(int day)

Used to check if a given day is present in the by day set. The day values are considered regarding the constants of the Calendar class: Calendar.SUNDAY, Calendar.MONDAY etc.

Parameters:

day - the day to be checked.

Returns:

true if the day is present in the set, false otherwise.

byMonth

public boolean byMonth(int month)

Used to check if a given month is present in the by month set. The day values are considered regarding the constants of the Calendar class: Calendar.JANUARY, Calendar.FEBRUARY etc.

Parameters:

month - the month to be checked.

Returns:

true if the month is present in the set, false otherwise.

repeatUntilDate

public long repeatUntilDate()

Gets the repeat until date if present. Default value is 0.

Returns:

the current repeat until date.

count

public int count()

Gets the count used in repeating the event. Default value is 0.

Returns:

the current count.

weekStartDay

public int weekStartDay()

Gets the start of the week for this event. Default value is Calendar.MONDAY

Returns:

the current week start.

interval

public int interval()

Gets the interval in which the recurrence occurs. Default value is 1.

Returns:

the current interval.

isBySecond

public boolean isBySecond()

Gets a value stating whether the rule has defined bySecond values.

Returns:

true if there are defined values, false otherwise.

isByMinute

public boolean isByMinute()

Gets a value stating whether the rule has defined byMinute values.

Returns:

true if there are defined values, false otherwise.

isByHour

public boolean isByHour()

Gets a value stating whether the rule has defined byHour values.

Returns:

true if there are defined values, false otherwise.

isByMonthDay

public boolean isByMonthDay()

Gets a value stating whether the rule has defined byMonthDay values.

Returns:

true if there are defined values, false otherwise.

isByYearDay

public boolean isByYearDay()

Gets a value stating whether the rule has defined byYearDay values.

Returns:

true if there are defined values, false otherwise.

isByWeekNo

public boolean isByWeekNo()

Gets a value stating whether the rule has defined byWeekNo values.

Returns:

true if there are defined values, false otherwise.

isBySetPos

public boolean isBySetPos()

Gets a value stating whether the rule has defined bySetPos values.

Returns:

true if there are defined values, false otherwise.

isByDay

public boolean isByDay()

Gets a value determining whether the rule is stated as byday rule.

Returns:

true if the rule is by day, false otherwise.

isByMonth

public boolean isByMonth()

Gets a value determining whether the rule is stated as byMonth rule.

Returns:

true if the rule is by month, false otherwise.

isModified

public boolean isModified()

Gets a value determining whether the rule is being modified using additional nth ocurrence rule as in -2MO or in BYSETPOS=-1.

Returns:

true if the rrule is modified, false otherwise.

isByDayModified

public boolean isByDayModified()

Gets a value determining whether the BYDAY rule is modified such as in -1MO.

Returns:

true if the BYDAY has been modified, false otherwise.

frequency

public Frequency frequency()

Gets the frequency at which the rule recurs.

Returns:

the current frequency.

bySetPos

public int[] bySetPos()

Gets the BYSETPOS values for the recurrance. Default value is null

Returns:

the current BYSETPOS values.