Enum Class RepeatInterval

java.lang.Object
java.lang.Enum<RepeatInterval>
com.inet.taskplanner.server.api.trigger.time.RepeatInterval
All Implemented Interfaces:
Serializable, Comparable<RepeatInterval>, Constable

public enum RepeatInterval extends Enum<RepeatInterval>
These are repeating intervals which you can use for your TimeTrigger.
Since:
taskplanner 3.0
See Also:
  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>
  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    Daily, weekly or monthly with custom interval.
    The task will be triggered on each day.
    The task will be triggered once a month.
    No Repetition.
    The task will be triggered every 3 month one the day of month of the start date.
    The task will be triggered every two weeks on the day of the startDate.
    The task will be triggered once a week on the day of the startDate.
    The task will be triggered on each workday, that is from monday to friday.
    The task will be triggered once a year on the day (and month) of the startday.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the enum constant of this class with the specified name.
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait
  • Enum Constant Details

    • NONE

      public static final RepeatInterval NONE
      No Repetition. The task is executed at the startDate and never again.
    • DAILY

      public static final RepeatInterval DAILY
      The task will be triggered on each day.
    • WORKDAYS

      public static final RepeatInterval WORKDAYS
      The task will be triggered on each workday, that is from monday to friday.
    • WEEKLY

      public static final RepeatInterval WEEKLY
      The task will be triggered once a week on the day of the startDate. So if the startDate is on a Thursday, then this will trigger on each Thursday.
    • TWOWEEKS

      public static final RepeatInterval TWOWEEKS
      The task will be triggered every two weeks on the day of the startDate. So if the startDate is on a Thursday, then this will trigger on each 2nd Thursday.
    • MONTHLY

      public static final RepeatInterval MONTHLY
      The task will be triggered once a month. Here you can specify an MonthlyDay. See MonthlyDay for details.
    • QUARTERLY

      public static final RepeatInterval QUARTERLY
      The task will be triggered every 3 month one the day of month of the start date.
    • YEARLY

      public static final RepeatInterval YEARLY
      The task will be triggered once a year on the day (and month) of the startday.
    • CUSTOM

      public static final RepeatInterval CUSTOM
      Daily, weekly or monthly with custom interval.

      This in only indirectly supported in the public api. Use the constants in TimeTriggerForCustomSettings to configure this and use the TimeTriggerFactory to validate this triggerDefinition.

      Since:
      taskplanner 22.4
  • Method Details

    • values

      public static RepeatInterval[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static RepeatInterval valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null