|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectipworks.CalRecurrence
public class CalRecurrence
Defines the recurrence set for an event.
The recurrence set is the complete
set of recurrence instances for a calendar component. The
recurrence set is generated by considering the initial CALDAV StartDate property along with the Rule
, Dates
, ExceptionRule
, and ExceptionDates
fields
contained within the recurring event. The CALDAV StartDate property
defines the first instance in the recurrence set. The starting date
SHOULD match the pattern of the recurrence rule, if
specified. The recurrence set generated with a start date that
doesn't match the pattern of the rule is undefined.
The final recurrence set is generated by gathering all of the
start DATE-TIME values generated by any of the specified Rule
and Dates
fields, and then excluding any start DATE-TIME
values specified by the ExceptionRule
or ExceptionDates
fields. This implies that
DATE-TIME values specified by the ExceptionRule
and ExceptionDates
fields take precedence
over those specified by inclusion properties (i.e., Dates
and Rule
). When duplicate instances are generated by the recurrence Rule
and Dates
fields, only one recurrence is considered.
Duplicate instances are ignored.
Dates: Individual dates on which the event will recur.
This field is used if you wish to denote specific, individual dates on which the event recurs. If you have an event that occurs monthly or weekly or on some other time interval, use the Rule
field instead.
This field is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this field will only be valid inside the CALDAV EventDetails event.
ExceptionDates: Defines the list of DATE-TIME exceptions to the recurrence set.
If the ExceptionDates
and ExceptionRule
are specified, they are used in computing the recurrence set.
The recurrence set is the complete
set of recurrence instances for a calendar component. The
recurrence set is generated by considering the initial CALDAV StartDate property along with the Rule
, Dates
, ExceptionRule
, and ExceptionDates
fields
contained within the recurring event. The CALDAV StartDate property
defines the first instance in the recurrence set. The starting date
SHOULD match the pattern of the recurrence rule, if
specified. The recurrence set generated with a start date that
doesn't match the pattern of the rule is undefined.
The final recurrence set is generated by gathering all of the
start DATE-TIME values generated by any of the specified Rule
and Dates
fields, and then excluding any start DATE-TIME
values specified by the ExceptionRule
or ExceptionDates
fields. This implies that
DATE-TIME values specified by the ExceptionRule
and ExceptionDates
fields take precedence
over those specified by inclusion properties (i.e., Dates
and Rule
). When duplicate instances are generated by the recurrence Rule
and Dates
fields, only one recurrence is considered.
Duplicate instances are ignored.
The date/time format is "YYYYMMDDThhmmss", where "T" indicates the break between date and time. You may also append a 1-character alpha code for the timezone. For instance, "20100104T123456Z" indicates January 4th, 2010 at 12:34:56 PM UTC.
This field is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this field will only be valid inside the CALDAV EventDetails event.
ExceptionRule: Defines a rule or repeating pattern for an exception to the recurrence set.
If the ExceptionDates
and ExceptionRule
are specified, they are used in computing the recurrence set.
The recurrence set is the complete
set of recurrence instances for a calendar component. The
recurrence set is generated by considering the initial CALDAV StartDate property along with the Rule
, Dates
, ExceptionRule
, and ExceptionDates
fields
contained within the recurring event. The CALDAV StartDate property
defines the first instance in the recurrence set. The starting date
SHOULD match the pattern of the recurrence rule, if
specified. The recurrence set generated with a start date that
doesn't match the pattern of the rule is undefined.
The final recurrence set is generated by gathering all of the
start DATE-TIME values generated by any of the specified Rule
and Dates
fields, and then excluding any start DATE-TIME
values specified by the ExceptionRule
or ExceptionDates
fields. This implies that
DATE-TIME values specified by the ExceptionRule
and ExceptionDates
fields take precedence
over those specified by inclusion properties (i.e., Dates
and Rule
). When duplicate instances are generated by the recurrence Rule
and Dates
fields, only one recurrence is considered.
Duplicate instances are ignored.
This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.
The table below shows the supported rules and their usage.
Rule
" is considered to repeat forever.
Rule
.
Rule
has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when
in a YEARLY Rule
when a BYWEEKNO rule part is specified. The default value is MO.
Information not contained in the Rule
necessary to determine the
various recurrence instance start time and dates are derived from
the CALDAV StartDate property. For example, "FREQ=YEARLY;BYMONTH=1"
doesn't specify a specific day within the
month or a time. This information would be the same as what is
specified for the CALDAV StartDate property.
BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.
If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.
This field is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this field will only be valid inside the CALDAV EventDetails event.
RecurrenceId: Identifies a recurring event.
This field is used in conjunction with the CALDAV UID and Sequence properties to identify a specific instance of a recurring event, todo, or journal. The value of this field is the value of the CALDAV StartDate property of the original recurrence instance.
This field is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this field will only be valid inside the CALDAV EventDetails event.
Rule: This field defines the recurrence rule for the event.
This value type is a structured value consisting of a list of one or more recurrence grammar parts. Each rule part is defined by a NAME=VALUE pair. The rule parts are separated from each other by the SEMICOLON character. The rule parts are not ordered in any particular sequence. Individual rule parts MUST only be specified once.
The table below shows the supported rules and their usage.
Rule
" is considered to repeat forever.
Rule
.
Rule
has an interval greater than 1, and a BYDAY rule part is specified. This is also significant when
in a YEARLY Rule
when a BYWEEKNO rule part is specified. The default value is MO.
Information not contained in the Rule
necessary to determine the
various recurrence instance start time and dates are derived from
the CALDAV StartDate property. For example, "FREQ=YEARLY;BYMONTH=1"
doesn't specify a specific day within the
month or a time. This information would be the same as what is
specified for the CALDAV StartDate property.
BYxxx rule parts modify the recurrence in some manner. BYxxx rule parts for a period of time that is the same or greater than the frequency generally reduce or limit the number of occurrences of the recurrence generated. For example, "FREQ=DAILY;BYMONTH=1" reduces the number of recurrence instances from all days (if BYMONTH rule part is not present) to all days in January. BYxxx rule parts for a period of time less than the frequency generally increase or expand the number of occurrences of the recurrence. For example, "FREQ=YEARLY;BYMONTH=1,2" increases the number of days within the yearly recurrence set from 1 (if BYMONTH rule part is not present) to 2.
If multiple BYxxx rule parts are specified, then after evaluating the specified FREQ and INTERVAL rule parts, the BYxxx rule parts are applied to the current set of evaluated occurrences in the following order: BYMONTH, BYWEEKNO, BYYEARDAY, BYMONTHDAY, BYDAY, BYHOUR, BYMINUTE, BYSECOND and BYSETPOS; then COUNT and UNTIL are evaluated.
This field is filled after retrieving a calendar event, and is also used to create an event to put on the server. However, when requesting a report the contents of this field will only be valid inside the CALDAV EventDetails event.
Atom
,
Atom.CalRecurrence
Constructor Summary | |
---|---|
CalRecurrence()
|
Method Summary | |
---|---|
java.lang.String |
getDates()
|
java.lang.String |
getExceptionDates()
|
java.lang.String |
getExceptionRule()
|
java.lang.String |
getRecurrenceId()
|
java.lang.String |
getRule()
|
void |
setDates(java.lang.String value)
|
void |
setExceptionDates(java.lang.String value)
|
void |
setExceptionRule(java.lang.String value)
|
void |
setRecurrenceId(java.lang.String value)
|
void |
setRule(java.lang.String value)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CalRecurrence()
Method Detail |
---|
public java.lang.String getDates()
public void setDates(java.lang.String value)
public java.lang.String getExceptionDates()
public void setExceptionDates(java.lang.String value)
public java.lang.String getExceptionRule()
public void setExceptionRule(java.lang.String value)
public java.lang.String getRecurrenceId()
public void setRecurrenceId(java.lang.String value)
public java.lang.String getRule()
public void setRule(java.lang.String value)
|
IP*Works! V9 | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |