Enum RepeatInterval
- java.lang.Object
-
- java.lang.Enum<RepeatInterval>
-
- com.inet.taskplanner.server.api.trigger.time.RepeatInterval
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<RepeatInterval>
public enum RepeatInterval extends java.lang.Enum<RepeatInterval>
These are repeating intervals which you can use for yourTimeTrigger
.- Since:
- taskplanner 3.0
- See Also:
TimeTriggerBuilder
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CUSTOM
Daily, weekly or monthly with custom interval.DAILY
The task will be triggered on each day.MONTHLY
The task will be triggered once a month.NONE
No Repetition.QUARTERLY
The task will be triggered every 3 month one the day of month of the start date.TWOWEEKS
The task will be triggered every two weeks on the day of the startDate.WEEKLY
The task will be triggered once a week on the day of the startDate.WORKDAYS
The task will be triggered on each workday, that is from monday to friday.YEARLY
The task will be triggered once a year on the day (and month) of the startday.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static RepeatInterval
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static RepeatInterval[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
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 anMonthlyDay
. SeeMonthlyDay
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 theTimeTriggerFactory
to validate this triggerDefinition.- Since:
- taskplanner 22.4
-
-
Method Detail
-
values
public static RepeatInterval[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (RepeatInterval c : RepeatInterval.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RepeatInterval valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
-