public class SimpleRULE
Represents a base rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.
| Modifier and Type | Field and Description |
|---|---|
BBjNumber | Count!=null()Number of times for event recurrence. Required if not using UntilDate or UntilDateTime. |
BBjString | FREQ_DAILY!="DAILY"Constant for days |
BBjString | FREQ_HOURLY!="HOURLY"Constant for hours |
BBjString | FREQ_MINUTELY!="MINUTELY"Constant for minutes |
BBjString | FREQ_MONTHLY!="MONTHLY"Constant for months |
BBjString | FREQ_SECONDLY!="SECONDLY"Constant for seconds |
BBjString | FREQ_WEEKLY!="WEEKLY"Constant for weeks |
BBjString | Frequency!=null()Frequency with which an event or exception should occur: required |
BBjNumber | Interval!=null()Interval. If frequency is set to "WEEKLY" and Interval is set to 3, then the recurrence or exception is once every 3 weeks. |
Date | UntilDate!=null()Until date for recurrence or exception. Required if not using Count or UntilDateTime |
Date | UntilDateTime!=null()Until date and time for recurrence or exception. Required if not using Count or UntilDate |
| Modifier and Type | Method and Description |
|---|---|
void | setCount(BBjNumber count)Sets the number of times a recurring event should recur. This field is mutually exclusive of untildate and untildatetime. If you set this field, it will set the other two to null(). |
void | setFrequency(BBjString frequency$)Describes the regularity with which the event occurs. Possible values include every second, every minute, every hour, every day, every week, every month, and every year. Sorry, no values are available for every decade, century, and millenium. |
void | setUntilDate(java.util.Date date!)Sets a date for a recurring event to end. This field is mutually exclusive of count and untildatetime. If you set this field, it will set the other two to null(). |
void | setUntilDateTime(java.util.Date dateTime!)Sets a date and time for a recurring event to end. This field is mutually exclusive of count and untildate. If you set this field, it will set the other two to null(). |
BBjString | toString()Creates a formatted string from the populated fields. In order for the string to constitute a valid rule, the following fields must be set: Frequency and one of Count, UntilDate, or UntilDateTime. |
public BBjNumber Count!=null()Number of times for event recurrence. Required if not using UntilDate or UntilDateTime.
public BBjString FREQ_DAILY!="DAILY"Constant for days
public BBjString FREQ_HOURLY!="HOURLY"Constant for hours
public BBjString FREQ_MINUTELY!="MINUTELY"Constant for minutes
public BBjString FREQ_MONTHLY!="MONTHLY"Constant for months
public BBjString FREQ_SECONDLY!="SECONDLY"Constant for seconds
public BBjString FREQ_WEEKLY!="WEEKLY"Constant for weeks
public BBjString Frequency!=null()Frequency with which an event or exception should occur: required
public BBjNumber Interval!=null()Interval. If frequency is set to "WEEKLY" and Interval is set to 3, then the recurrence or exception is once every 3 weeks.
public Date UntilDate!=null()Until date for recurrence or exception. Required if not using Count or UntilDateTime
public Date UntilDateTime!=null()Until date and time for recurrence or exception. Required if not using Count or UntilDate
public void setCount(BBjNumber count)
Sets the number of times a recurring event should recur. This field is mutually exclusive of untildate and untildatetime. If you set this field, it will set the other two to null().
count Number of times the recurring event should recur.public void setFrequency(BBjString frequency$)
Describes the regularity with which the event occurs. Possible values include every second, every minute, every hour, every day, every week, every month, and every year. Sorry, no values are available for every decade, century, and millenium.
frequency$ String describing the regularity with which an event will occur. Valid values are one of: getFREQ_SECONDLY() getFREQ_MINUTELY() getFREQ_HOURLY() getFREQ_DAILY() getFREQ_WEEKLY() getFREQ_MONTHLY() getFREQ_YEARLY()public void setUntilDate(java.util.Date date!)Sets a date for a recurring event to end. This field is mutually exclusive of count and untildatetime. If you set this field, it will set the other two to null().
date! a java.util.Date for the ending date of the recurring sequence.public void setUntilDateTime(java.util.Date dateTime!)Sets a date and time for a recurring event to end. This field is mutually exclusive of count and untildate. If you set this field, it will set the other two to null().
dateTime! a java.util.Date for the ending date and time of the recurring sequence.public BBjString toString()Creates a formatted string from the populated fields. In order for the string to constitute a valid rule, the following fields must be set: Frequency and one of Count, UntilDate, or UntilDateTime.