Class RecurrenceRule
java.lang.Object
org.daypilot.recurrence.RecurrenceRule
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumRepeat range definition type (Until, or Times). -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final RecurrenceRuleSpecifies that this event represents an exception from rule defined in the main event. static final RecurrenceRuleSpecifies that the event does not recur. -
Method Summary
Modifier and TypeMethodDescriptionannually()Specifies that the event will repeat every year. daily()Specifies that the event will repeat daily. daily(int every) Specifies that the event will repeat every x days. static RecurrenceRuleLoads a rule from a string encoded using Encode() method (DataRecurrenceField). encode()Creates a string representation of the rule that can be stored in the database (DataRecurrenceField). static StringencodeExceptionDeleted(String masterId, DateTime start) Creates a string representation of a 'Deleted' exception from the rule that can be stored in the database (DataRecurrenceField). static StringencodeExceptionModified(String masterId, DateTime start) Creates a string representation of a 'Modified' exception from the rule that can be stored in the database (DataRecurrenceField). static RecurrenceRulefromDateTime(String id, DateTime start) Creates a new RecurrenceRule from starting DateTime. static RecurrenceRuleintgetEvery()getId()getNamed()getUnits()The event will repeat indefinitely. monthly()Specifies that the event will repeat every month. monthly(int[] days, int[] months) Specifies that the event will repeat in certain months on certain days of month. Specifies that the event will repeat every month on certain days of month. Specifies that the event will repeat every x month on certain days of month. occurrences(DateTime limit) voidsetEvery(int every) voidvoidvoidvoidsetRepeat(RepeatRule repeat) voidtimes(int times) How many times it will be repeated. ToJson()Serializes the rule to a JSON string that can be used to fill the UI dialog (RecurrentEventEdit.aspx). Serializes the rule to a JSON string that can be used to fill the UI dialog (RecurrentEventEdit.aspx). What the ending date of the repeat range. weekly()Specifies that the event will repeat every week. Specifies that the event will repeat on certain days every week.
-
Field Details
-
NOREPEAT
Specifies that the event does not recur. -
EXCEPTION
Specifies that this event represents an exception from rule defined in the main event.
-
-
Method Details
-
getId
-
setId
-
getRangeSpec
-
setRangeSpec
-
getUntilValue
-
getTimesValue
-
fromDateTime
Creates a new RecurrenceRule from starting DateTime. It prefills certain fields but it's still necessary to specify it further by calling methods like Weekly(). Event id. Starting DateTime. -
monthly
Specifies that the event will repeat every month. -
monthly
Specifies that the event will repeat every month on certain days of month. -
monthly
Specifies that the event will repeat every x month on certain days of month. -
annually
Specifies that the event will repeat every year. -
monthly
Specifies that the event will repeat in certain months on certain days of month. -
daily
Specifies that the event will repeat daily. -
daily
Specifies that the event will repeat every x days. -
weekly
Specifies that the event will repeat every week. -
weekly
Specifies that the event will repeat on certain days every week. -
weekly
-
times
How many times it will be repeated. -
until
What the ending date of the repeat range. -
indefinitely
The event will repeat indefinitely. -
encode
Creates a string representation of the rule that can be stored in the database (DataRecurrenceField). -
encodeExceptionModified
-
encodeExceptionDeleted
-
decode
Loads a rule from a string encoded using Encode() method (DataRecurrenceField). -
ToJson
Serializes the rule to a JSON string that can be used to fill the UI dialog (RecurrentEventEdit.aspx). It is only able to serialize a subset of the possible rules that can be loaded by the dialog. It uses the culture of the current thread. -
ToJson
-
fromJson
-
occurrences
-
getRepeat
-
setRepeat
-
getEvery
public int getEvery() -
setEvery
public void setEvery(int every) -
getNamed
-
setNamed
-
getUnits
-
setUnits
-
next
-