Package org.opfab.cards.model

Class RRule

java.lang.Object
org.opfab.cards.model.RRule
public class RRule extends Object
An object representing the recurrence of the card (as defined in the RFC 5545)

  • Constructor Details

    • RRule

      public RRule()

  • Method Details

    • freq

      public RRule freq(FreqEnum freq)

    • getFreq

      public FreqEnum getFreq()
      Frequency of the recurrence
      Returns:
      freq

    • setFreq

      public void setFreq(FreqEnum freq)

    • interval

      public RRule interval(Integer interval)

    • getInterval

      public Integer getInterval()
      Represents at which intervals the recurrence rule repeats. The default value is \"1\", meaning every second for a SECONDLY rule, every minute for a MINUTELY rule etc.
      Returns:
      interval

    • setInterval

      public void setInterval(Integer interval)

    • count

      public RRule count(Integer count)

    • getCount

      public Integer getCount()
      Defines the number of occurrences at which to range-bound the recurrence
      Returns:
      count

    • setCount

      public void setCount(Integer count)

    • wkst

      public RRule wkst(DayEnum wkst)

    • getWkst

      public DayEnum getWkst()
      Defines the day on which the workweek starts. Valid values are MO, TU, WE, TH, FR, SA, and SU.
      Returns:
      wkst

    • setWkst

      public void setWkst(DayEnum wkst)

    • byweekday

      public RRule byweekday(List<DayEnum> byweekday)

    • addByweekdayItem

      public RRule addByweekdayItem(DayEnum byweekdayItem)

    • getByweekday

      public List<DayEnum> getByweekday()
      Defines a list of days of the week for the recurrence
      Returns:
      byweekday

    • setByweekday

      public void setByweekday(List<DayEnum> byweekday)

    • bymonth

      public RRule bymonth(List<Integer> bymonth)

    • addBymonthItem

      public RRule addBymonthItem(Integer bymonthItem)

    • getBymonth

      public List<Integer> getBymonth()
      Defines a list of months of the year for the recurrence (from 1 to 12, 1 representing January)
      Returns:
      bymonth

    • setBymonth

      public void setBymonth(List<Integer> bymonth)

    • byhour

      public RRule byhour(List<Integer> byhour)

    • addByhourItem

      public RRule addByhourItem(Integer byhourItem)

    • getByhour

      public List<Integer> getByhour()
      Defines a list of hours of the day for the recurrence (from 0 to 23)
      Returns:
      byhour

    • setByhour

      public void setByhour(List<Integer> byhour)

    • byminute

      public RRule byminute(List<Integer> byminute)

    • addByminuteItem

      public RRule addByminuteItem(Integer byminuteItem)

    • getByminute

      public List<Integer> getByminute()
      Defines a list of minutes within an hour for the recurrence (from 0 to 59)
      Returns:
      byminute

    • setByminute

      public void setByminute(List<Integer> byminute)

    • bysetpos

      public RRule bysetpos(List<Integer> bysetpos)

    • addBysetposItem

      public RRule addBysetposItem(Integer bysetposItem)

    • getBysetpos

      public List<Integer> getBysetpos()
      Array of integers, positive or negative. Each given integer will specify an occurrence number, corresponding to the nth occurrence of the rule inside the frequency period
      Returns:
      bysetpos

    • setBysetpos

      public void setBysetpos(List<Integer> bysetpos)

    • bymonthday

      public RRule bymonthday(List<Integer> bymonthday)

    • addBymonthdayItem

      public RRule addBymonthdayItem(Integer bymonthdayItem)

    • getBymonthday

      public List<Integer> getBymonthday()
      Defines the month days to apply the recurrence to
      Returns:
      bymonthday

    • setBymonthday

      public void setBymonthday(List<Integer> bymonthday)

    • tzid

      public RRule tzid(String tzid)

    • getTzid

      public String getTzid()
      Time zone identifier (for example 'Europe/Paris', 'Europe/London', ...)
      Returns:
      tzid

    • setTzid

      public void setTzid(String tzid)

    • durationInMinutes

      public RRule durationInMinutes(Integer durationInMinutes)

    • getDurationInMinutes

      public Integer getDurationInMinutes()
      Duration in minutes of the event minimum: 0
      Returns:
      durationInMinutes

    • setDurationInMinutes

      public void setDurationInMinutes(Integer durationInMinutes)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object