SimpleRULE

java.lang.Object
- gappsv3.SimpleRULE

Direct Known Subclasses:

SimpleEXRULE, SimpleRRULE
```
public class SimpleRULE
extends Object
```
Represents a base rule and constructs syntax for common simple cases. For more complicated scenarios, consult RFC2445 and construct your own string.

See Also:

https://www.ietf.org/rfc/rfc2445.txt

Field Summary

Fields
Modifier and Type	Field and Description
`BBjNumber`	`Count!` Number of times for event recurrence.
`BBjString`	`FREQ_DAILY!` Constant for days
`BBjString`	`FREQ_HOURLY!` Constant for hours
`BBjString`	`FREQ_MINUTELY!` Constant for minutes
`BBjString`	`FREQ_MONTHLY!` Constant for months
`BBjString`	`FREQ_SECONDLY!` Constant for seconds
`BBjString`	`FREQ_WEEKLY!` Constant for weeks
`BBjString`	`Frequency!` Frequency with which an event or exception should occur: required
`BBjNumber`	`Interval!` Interval.
`Date`	`UntilDate!` Until date for recurrence or exception.
`Date`	`UntilDateTime!` Until date and time for recurrence or exception.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`setCount(BBjNumber count)` Sets the number of times a recurring event should recur.
`void`	`setFrequency(BBjString frequency$)` Describes the regularity with which the event occurs.
`void`	`setUntilDate(Date date!)` Sets a date for a recurring event to end.
`void`	`setUntilDateTime(Date dateTime!)` Sets a date and time for a recurring event to end.
`BBjString`	`toString()` Creates a formatted string from the populated fields.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FREQ_SECONDLY!
```
public BBjString FREQ_SECONDLY!
```
    Constant for seconds
  - FREQ_MINUTELY!
```
public BBjString FREQ_MINUTELY!
```
    Constant for minutes
  - FREQ_HOURLY!
```
public BBjString FREQ_HOURLY!
```
    Constant for hours
  - FREQ_DAILY!
```
public BBjString FREQ_DAILY!
```
    Constant for days
  - FREQ_WEEKLY!
```
public BBjString FREQ_WEEKLY!
```
    Constant for weeks
  - FREQ_MONTHLY!
```
public BBjString FREQ_MONTHLY!
```
    Constant for months
  - Frequency!
```
public BBjString Frequency!
```
    Frequency with which an event or exception should occur: required
  - UntilDate!
```
public Date UntilDate!
```
    Until date for recurrence or exception. Required if not using Count or UntilDateTime
  - UntilDateTime!
```
public Date UntilDateTime!
```
    Until date and time for recurrence or exception. Required if not using Count or UntilDate
  - Count!
```
public BBjNumber Count!
```
    Number of times for event recurrence. Required if not using UntilDate or UntilDateTime.
  - Interval!
```
public BBjNumber Interval!
```
    Interval. If frequency is set to "WEEKLY" and Interval is set to 3, then the recurrence or exception is once every 3 weeks.
- Method Detail
  - setFrequency
```
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.
    
    Parameters:
    
    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()
  - setCount
```
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().
    
    Parameters:
    
    count - Number of times the recurring event should recur.
  - setUntilDate
```
public void setUntilDate(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().
    
    Parameters:
    
    date! - a java.util.Date for the ending date of the recurring sequence.
  - setUntilDateTime
```
public void setUntilDateTime(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().
    
    Parameters:
    
    dateTime! - a java.util.Date for the ending date and time of the recurring sequence.
  - toString
```
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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A formatted rule string. Can be an invalid rule string if any required fields have been left null.

Class SimpleRULE

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FREQ_SECONDLY!

FREQ_MINUTELY!

FREQ_HOURLY!

FREQ_DAILY!

FREQ_WEEKLY!

FREQ_MONTHLY!

Frequency!

UntilDate!

UntilDateTime!

Count!

Interval!

Method Detail

setFrequency

setCount

setUntilDate

setUntilDateTime

toString