Recurrent (Silverpeas Core 6.3 API)

All Known Implementing Classes:

CalendarEvent
```
public interface Recurrent
```
This interface is dedicated to be applied on PlannableOnCalendar implementations. It qualifies a PlannableOnCalendar can be recurrent, periodic, over the timeline. By default, a recurrent PlannableOnCalendar has no defined recurrence rules; hence it is no recurrent.

Author:

mmoquillon

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Recurrence`	`getRecurrence()`	Gets the actual recurrence rules.
`default boolean`	`isRecurrent()`	Is this `PlannableOnCalendar` recurrent?
`Recurrent`	`recur(Recurrence recurrence)`	Recurs this recurrent object with the specified recurrence rules.
`void`	`unsetRecurrence()`	Unset the recurrence of this possibly recurrent object.

- Method Detail
  - recur
```
Recurrent recur(Recurrence recurrence)
```
    Recurs this recurrent object with the specified recurrence rules.
    
    Parameters:
    
    recurrence - the recurrence defining the recurring rules to apply in the planning of this PlannableOnCalendar.
    
    Returns:
    
    itself.
  - getRecurrence
```
Recurrence getRecurrence()
```
    Gets the actual recurrence rules. If no recurrence has been set, then returns NO_RECURRENCE.
    
    Returns:
    
    the actual recurrence of this PlannableOnCalendar or NO_RECURRENCE.
  - unsetRecurrence
```
void unsetRecurrence()
```
    Unset the recurrence of this possibly recurrent object. It is no more recurrent.
  - isRecurrent
```
default boolean isRecurrent()
```
    Is this PlannableOnCalendar recurrent?
    
    Returns:
    
    true if a recurrence has been set for this object, false otherwise.