RecurringData (MPXJ 13.8.0 API)

java.lang.Object
- net.sf.mpxj.RecurringData

Direct Known Subclasses:

RecurringTask
```
public class RecurringData
extends Object
```
This class provides a description of a recurring event.

Constructor Summary

Constructors
Constructor and Description

RecurringData()

Constructors
Constructor and Description
`RecurringData()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LocalDate`	`getCalculatedFirstDate()` Retrieve the first calculated date on which an exception will actually occur.
`LocalDate`	`getCalculatedLastDate()` Retrieve the last calculated date on which an exception will actually occur.
`LocalDate[]`	`getDates()` Retrieve the set of start dates represented by this recurrence data.
`Integer`	`getDayNumber()` Retrieves the monthly or yearly absolute day number.
`DayOfWeek`	`getDayOfWeek()` Retrieves the monthly or yearly relative day of the week.
`LocalDate`	`getFinishDate()` Gets the finish date of this recurrence.
`Integer`	`getFrequency()` Retrieves the recurrence frequency.
`Integer`	`getMonthNumber()` Retrieves the yearly month number.
`Integer`	`getOccurrences()` Sets the number of occurrences.
`RecurrenceType`	`getRecurrenceType()` Retrieves the recurrence type.
`boolean`	`getRelative()` Retrieves the relative flag.
`LocalDate`	`getStartDate()` Gets the start date of this recurrence.
`boolean`	`getUseEndDate()` Retrieves the use end date flag.
`boolean`	`getWeeklyDay(DayOfWeek day)` Returns true if this day is part of a weekly recurrence.
`boolean`	`getWorkingDaysOnly()` Returns true if daily recurrence applies to working days only.
`boolean`	`isValid()` Returns true if the configuration is valid, i.e.
`void`	`setDayNumber(Integer day)` Sets the monthly or yearly absolute day number.
`void`	`setDayOfWeek(DayOfWeek day)` Sets the monthly or yearly relative day of the week.
`void`	`setFinishDate(LocalDate val)` Sets the finish date of this recurrence.
`void`	`setFrequency(Integer frequency)` Set the recurrence frequency.
`void`	`setMonthNumber(Integer month)` Sets the yearly month number.
`void`	`setOccurrences(Integer occurrences)` Retrieves the number of occurrences.
`void`	`setRecurrenceType(RecurrenceType type)` Sets the recurrence type.
`void`	`setRelative(boolean relative)` Sets the relative flag.
`void`	`setStartDate(LocalDate val)` Sets the start date of this recurrence.
`void`	`setUseEndDate(boolean useEndDate)` Sets the use end date flag.
`void`	`setWeeklyDay(DayOfWeek day, boolean value)` Set the state of an individual day in a weekly recurrence.
`void`	`setWeeklyDaysFromBitmap(Integer days, int[] masks)` Converts from a bitmap to individual day flags for a weekly recurrence, using the array of masks.
`void`	`setWorkingDaysOnly(boolean workingDaysOnly)` Set to true if daily recurrence applies to working days only.
`void`	`setYearlyAbsoluteFromDate(LocalDate date)` Sets the yearly absolute date.
`String`	`toString()`

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

- Constructor Detail
  - RecurringData
```
public RecurringData()
```
- Method Detail
  - getStartDate
```
public LocalDate getStartDate()
```
    Gets the start date of this recurrence.
    
    Returns:
    
    recurrence start date
  - setStartDate
```
public void setStartDate(LocalDate val)
```
    Sets the start date of this recurrence.
    
    Parameters:
    
    val - recurrence start date
  - getFinishDate
```
public LocalDate getFinishDate()
```
    Gets the finish date of this recurrence.
    
    Returns:
    
    recurrence finish date
  - setFinishDate
```
public void setFinishDate(LocalDate val)
```
    Sets the finish date of this recurrence.
    
    Parameters:
    
    val - recurrence finish date
  - getOccurrences
```
public Integer getOccurrences()
```
    Sets the number of occurrences.
    
    Returns:
    
    number of occurrences
  - setOccurrences
```
public void setOccurrences(Integer occurrences)
```
    Retrieves the number of occurrences.
    
    Parameters:
    
    occurrences - number of occurrences
  - getRecurrenceType
```
public RecurrenceType getRecurrenceType()
```
    Retrieves the recurrence type.
    
    Returns:
    
    RecurrenceType instance
  - setRecurrenceType
```
public void setRecurrenceType(RecurrenceType type)
```
    Sets the recurrence type.
    
    Parameters:
    
    type - recurrence type
  - getUseEndDate
```
public boolean getUseEndDate()
```
    Retrieves the use end date flag.
    
    Returns:
    
    use end date flag
  - setUseEndDate
```
public void setUseEndDate(boolean useEndDate)
```
    Sets the use end date flag.
    
    Parameters:
    
    useEndDate - use end date flag
  - getWorkingDaysOnly
```
public boolean getWorkingDaysOnly()
```
    Returns true if daily recurrence applies to working days only.
    
    Returns:
    
    true if daily recurrence applies to working days only
  - setWorkingDaysOnly
```
public void setWorkingDaysOnly(boolean workingDaysOnly)
```
    Set to true if daily recurrence applies to working days only.
    
    Parameters:
    
    workingDaysOnly - true if daily recurrence applies to working days only
  - getWeeklyDay
```
public boolean getWeeklyDay(DayOfWeek day)
```
    Returns true if this day is part of a weekly recurrence.
    
    Parameters:
    
    day - Day instance
    
    Returns:
    
    true if this day is included
  - setWeeklyDay
```
public void setWeeklyDay(DayOfWeek day,
                         boolean value)
```
    Set the state of an individual day in a weekly recurrence.
    
    Parameters:
    
    day - Day instance
    
    value - true if this day is included in the recurrence
  - setWeeklyDaysFromBitmap
```
public void setWeeklyDaysFromBitmap(Integer days,
                                    int[] masks)
```
    Converts from a bitmap to individual day flags for a weekly recurrence, using the array of masks.
    
    Parameters:
    
    days - bitmap
    
    masks - array of mask values
  - getRelative
```
public boolean getRelative()
```
    Retrieves the relative flag. This is only relevant for monthly and yearly recurrence.
    
    Returns:
    
    boolean flag
  - setRelative
```
public void setRelative(boolean relative)
```
    Sets the relative flag. This is only relevant for monthly and yearly recurrence.
    
    Parameters:
    
    relative - boolean flag
  - getFrequency
```
public Integer getFrequency()
```
    Retrieves the recurrence frequency.
    
    Returns:
    
    recurrence frequency
  - setFrequency
```
public void setFrequency(Integer frequency)
```
    Set the recurrence frequency.
    
    Parameters:
    
    frequency - recurrence frequency
  - getDayOfWeek
```
public DayOfWeek getDayOfWeek()
```
    Retrieves the monthly or yearly relative day of the week.
    
    Returns:
    
    day of the week
  - setDayOfWeek
```
public void setDayOfWeek(DayOfWeek day)
```
    Sets the monthly or yearly relative day of the week.
    
    Parameters:
    
    day - day of the week
  - getDayNumber
```
public Integer getDayNumber()
```
    Retrieves the monthly or yearly absolute day number.
    
    Returns:
    
    absolute day number.
  - setDayNumber
```
public void setDayNumber(Integer day)
```
    Sets the monthly or yearly absolute day number.
    
    Parameters:
    
    day - absolute day number
  - getMonthNumber
```
public Integer getMonthNumber()
```
    Retrieves the yearly month number.
    
    Returns:
    
    month number
  - setMonthNumber
```
public void setMonthNumber(Integer month)
```
    Sets the yearly month number.
    
    Parameters:
    
    month - month number
  - getDates
```
public LocalDate[] getDates()
```
    Retrieve the set of start dates represented by this recurrence data.
    
    Returns:
    
    array of start dates
  - isValid
```
public boolean isValid()
```
    Returns true if the configuration is valid, i.e. it returns one or more start dates.
    
    Returns:
    
    true if the configuration is valid
  - getCalculatedFirstDate
```
public LocalDate getCalculatedFirstDate()
```
    Retrieve the first calculated date on which an exception will actually occur. The user-supplied start date may not align with the dates generated for the exception.
    
    Returns:
    
    first calculated exception date
  - getCalculatedLastDate
```
public LocalDate getCalculatedLastDate()
```
    Retrieve the last calculated date on which an exception will actually occur. The user-supplied finish date may not align with the dates generated for the exception.
    
    Returns:
    
    last calculated exception date
  - setYearlyAbsoluteFromDate
```
public void setYearlyAbsoluteFromDate(LocalDate date)
```
    Sets the yearly absolute date.
    
    Parameters:
    
    date - yearly absolute date
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RecurringData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecurringData

Method Detail

getStartDate

setStartDate

getFinishDate

setFinishDate

getOccurrences

setOccurrences

getRecurrenceType

setRecurrenceType

getUseEndDate

setUseEndDate

getWorkingDaysOnly

setWorkingDaysOnly

getWeeklyDay

setWeeklyDay

setWeeklyDaysFromBitmap

getRelative

setRelative

getFrequency

setFrequency

getDayOfWeek

setDayOfWeek

getDayNumber

setDayNumber

getMonthNumber

setMonthNumber

getDates

isValid

getCalculatedFirstDate

getCalculatedLastDate

setYearlyAbsoluteFromDate

toString