Enum JobGroupUpdateActionType
- java.lang.Object
-
- java.lang.Enum<JobGroupUpdateActionType>
-
- com.redwood.scheduler.api.model.enumeration.JobGroupUpdateActionType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<JobGroupUpdateActionType,Character>
,SchedulerEnumeration<JobGroupUpdateActionType>
,Serializable
,Comparable<JobGroupUpdateActionType>
public enum JobGroupUpdateActionType extends Enum<JobGroupUpdateActionType> implements SchedulerEnumeration<JobGroupUpdateActionType>
Specifies what action a job group reschedule must do. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Default
Update the process to use the new process definition.Edit
Recurrence changed, recalculate all processes.First
First submit of recurrence.NoAction
Don't update, use the old process definitionResubmit
Cancel the process and restart it.TimeWindowChange
Recalculate start times since some time window changed.
-
Field Summary
Fields Modifier and Type Field Description static char
DefaultCode
The char returned from Default.getCodeEx().static char
EditCode
The char returned from Edit.getCodeEx().static char
FirstCode
The char returned from First.getCodeEx().static char
NoActionCode
The char returned from NoAction.getCodeEx().static char
ResubmitCode
The char returned from Resubmit.getCodeEx().static char
TimeWindowChangeCode
The char returned from TimeWindowChange.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
getCodeExValue()
Return the code for the enumeration item as the database type of this enumeration.String
getDescriptionKey()
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.String
getTranslationEN()
Get the English name of this enumeration.String
getTranslationKey()
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static JobGroupUpdateActionType
safeValueOf(String value)
Helper function to return the JobGroupUpdateActionType represented byvalue
.static JobGroupUpdateActionType
valueOf(char code)
Helper function to return the JobGroupUpdateActionType represented by code.static JobGroupUpdateActionType
valueOf(Character code)
Helper function to return the JobGroupUpdateActionType represented by code.static JobGroupUpdateActionType
valueOf(String name)
Returns the enum constant of this type with the specified name.static JobGroupUpdateActionType
valueOfCode(String code)
Helper function to return the JobGroupUpdateActionType represented by code.static JobGroupUpdateActionType[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.-
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
NoAction
public static final JobGroupUpdateActionType NoAction
Don't update, use the old process definition
-
Default
public static final JobGroupUpdateActionType Default
Update the process to use the new process definition.
-
Resubmit
public static final JobGroupUpdateActionType Resubmit
Cancel the process and restart it.
-
Edit
public static final JobGroupUpdateActionType Edit
Recurrence changed, recalculate all processes.
-
First
public static final JobGroupUpdateActionType First
First submit of recurrence.
-
TimeWindowChange
public static final JobGroupUpdateActionType TimeWindowChange
Recalculate start times since some time window changed.
-
-
Field Detail
-
NoActionCode
public static final char NoActionCode
The char returned from NoAction.getCodeEx().- See Also:
NoAction
, Constant Field Values
-
DefaultCode
public static final char DefaultCode
The char returned from Default.getCodeEx().- See Also:
Default
, Constant Field Values
-
ResubmitCode
public static final char ResubmitCode
The char returned from Resubmit.getCodeEx().- See Also:
Resubmit
, Constant Field Values
-
EditCode
public static final char EditCode
The char returned from Edit.getCodeEx().- See Also:
Edit
, Constant Field Values
-
FirstCode
public static final char FirstCode
The char returned from First.getCodeEx().- See Also:
First
, Constant Field Values
-
TimeWindowChangeCode
public static final char TimeWindowChangeCode
The char returned from TimeWindowChange.getCodeEx().- See Also:
TimeWindowChange
, Constant Field Values
-
-
Method Detail
-
values
public static JobGroupUpdateActionType[] 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 (JobGroupUpdateActionType c : JobGroupUpdateActionType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobGroupUpdateActionType valueOf(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOfCode
public static JobGroupUpdateActionType valueOfCode(String code)
Helper function to return the JobGroupUpdateActionType represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for JobGroupUpdateActionType- Returns:
- The JobGroupUpdateActionType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static JobGroupUpdateActionType safeValueOf(String value)
Helper function to return the JobGroupUpdateActionType represented byvalue
. Ifvalue
is null, or not a valid JobGroupUpdateActionType enumeration then this method will return null.The main difference between this method and
valueOf(String)
, is that this method will return null when passed an invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The JobGroupUpdateActionType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static JobGroupUpdateActionType valueOf(Character code)
Helper function to return the JobGroupUpdateActionType represented by code. If code is null, or not a valid JobGroupUpdateActionType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The JobGroupUpdateActionType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static JobGroupUpdateActionType valueOf(char code)
Helper function to return the JobGroupUpdateActionType represented by code. If code is not a valid JobGroupUpdateActionType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The JobGroupUpdateActionType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<JobGroupUpdateActionType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<JobGroupUpdateActionType,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<JobGroupUpdateActionType>
- Returns:
- the database code for the enumeration
-
getTranslationKey
public String getTranslationKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
getTranslationKey
in interfaceBaseSchedulerEnumeration<JobGroupUpdateActionType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<JobGroupUpdateActionType,Character>
- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public String getDescriptionKey()
Description copied from interface:BaseSchedulerEnumeration
Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
getDescriptionKey
in interfaceBaseSchedulerEnumeration<JobGroupUpdateActionType,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<JobGroupUpdateActionType>
- Returns:
- the database code for the enumeration
-
-