Enum UpdateFutureJobActionType
- java.lang.Object
-
- java.lang.Enum<UpdateFutureJobActionType>
-
- com.redwood.scheduler.api.model.enumeration.UpdateFutureJobActionType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<UpdateFutureJobActionType,Character>
,SchedulerEnumeration<UpdateFutureJobActionType>
,Serializable
,Comparable<UpdateFutureJobActionType>
public enum UpdateFutureJobActionType extends Enum<UpdateFutureJobActionType> implements SchedulerEnumeration<UpdateFutureJobActionType>
Specifies what action to take on the job after a job definition change. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Abort
Abort the action that triggered the process definition change.CancelAndRestart
Cancel the process and restart it.CancelJob
Don't update, just cancel the process.HoldJob
Don't update, just hold the process.SetToError
Don't update, just set the process to Error.UseNewJobDefinition
Update the process to use the new process definition.UseOldJobDefinition
Don't update, use the old process definition
-
Field Summary
Fields Modifier and Type Field Description static char
AbortCode
The char returned from Abort.getCodeEx().static char
CancelAndRestartCode
The char returned from CancelAndRestart.getCodeEx().static char
CancelJobCode
The char returned from CancelJob.getCodeEx().static char
HoldJobCode
The char returned from HoldJob.getCodeEx().static char
SetToErrorCode
The char returned from SetToError.getCodeEx().static char
UseNewJobDefinitionCode
The char returned from UseNewJobDefinition.getCodeEx().static char
UseOldJobDefinitionCode
The char returned from UseOldJobDefinition.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 UpdateFutureJobActionType
safeValueOf(String value)
Helper function to return the UpdateFutureJobActionType represented byvalue
.static UpdateFutureJobActionType
valueOf(char code)
Helper function to return the UpdateFutureJobActionType represented by code.static UpdateFutureJobActionType
valueOf(Character code)
Helper function to return the UpdateFutureJobActionType represented by code.static UpdateFutureJobActionType
valueOf(String name)
Returns the enum constant of this type with the specified name.static UpdateFutureJobActionType
valueOfCode(String code)
Helper function to return the UpdateFutureJobActionType represented by code.static UpdateFutureJobActionType[]
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
-
UseOldJobDefinition
public static final UpdateFutureJobActionType UseOldJobDefinition
Don't update, use the old process definition
-
UseNewJobDefinition
public static final UpdateFutureJobActionType UseNewJobDefinition
Update the process to use the new process definition.
-
CancelAndRestart
public static final UpdateFutureJobActionType CancelAndRestart
Cancel the process and restart it.
-
HoldJob
public static final UpdateFutureJobActionType HoldJob
Don't update, just hold the process.
-
CancelJob
public static final UpdateFutureJobActionType CancelJob
Don't update, just cancel the process.
-
SetToError
public static final UpdateFutureJobActionType SetToError
Don't update, just set the process to Error.
-
Abort
public static final UpdateFutureJobActionType Abort
Abort the action that triggered the process definition change. Used as registry setting only. Used to abort import/promotion actions.
-
-
Field Detail
-
UseOldJobDefinitionCode
public static final char UseOldJobDefinitionCode
The char returned from UseOldJobDefinition.getCodeEx().- See Also:
UseOldJobDefinition
, Constant Field Values
-
UseNewJobDefinitionCode
public static final char UseNewJobDefinitionCode
The char returned from UseNewJobDefinition.getCodeEx().- See Also:
UseNewJobDefinition
, Constant Field Values
-
CancelAndRestartCode
public static final char CancelAndRestartCode
The char returned from CancelAndRestart.getCodeEx().- See Also:
CancelAndRestart
, Constant Field Values
-
HoldJobCode
public static final char HoldJobCode
The char returned from HoldJob.getCodeEx().- See Also:
HoldJob
, Constant Field Values
-
CancelJobCode
public static final char CancelJobCode
The char returned from CancelJob.getCodeEx().- See Also:
CancelJob
, Constant Field Values
-
SetToErrorCode
public static final char SetToErrorCode
The char returned from SetToError.getCodeEx().- See Also:
SetToError
, Constant Field Values
-
AbortCode
public static final char AbortCode
The char returned from Abort.getCodeEx().- See Also:
Abort
, Constant Field Values
-
-
Method Detail
-
values
public static UpdateFutureJobActionType[] 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 (UpdateFutureJobActionType c : UpdateFutureJobActionType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static UpdateFutureJobActionType 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 UpdateFutureJobActionType valueOfCode(String code)
Helper function to return the UpdateFutureJobActionType 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 UpdateFutureJobActionType- Returns:
- The UpdateFutureJobActionType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static UpdateFutureJobActionType safeValueOf(String value)
Helper function to return the UpdateFutureJobActionType represented byvalue
. Ifvalue
is null, or not a valid UpdateFutureJobActionType 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 UpdateFutureJobActionType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static UpdateFutureJobActionType valueOf(Character code)
Helper function to return the UpdateFutureJobActionType represented by code. If code is null, or not a valid UpdateFutureJobActionType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The UpdateFutureJobActionType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static UpdateFutureJobActionType valueOf(char code)
Helper function to return the UpdateFutureJobActionType represented by code. If code is not a valid UpdateFutureJobActionType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The UpdateFutureJobActionType 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<UpdateFutureJobActionType>
- 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<UpdateFutureJobActionType,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<UpdateFutureJobActionType>
- 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<UpdateFutureJobActionType,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<UpdateFutureJobActionType,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<UpdateFutureJobActionType,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<UpdateFutureJobActionType>
- Returns:
- the database code for the enumeration
-
-