Enum CompletionStrategyType
- java.lang.Object
-
- java.lang.Enum<CompletionStrategyType>
-
- com.redwood.scheduler.api.model.enumeration.CompletionStrategyType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<CompletionStrategyType,Character>
,SchedulerEnumeration<CompletionStrategyType>
,Serializable
,Comparable<CompletionStrategyType>
public enum CompletionStrategyType extends Enum<CompletionStrategyType> implements SchedulerEnumeration<CompletionStrategyType>
The completion strategy. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Default
Set the process to a final status when the process-thread/process finishes executing.External
Leave the process in 'Running' state, its status will be updated externally.ExternalWaitForChildJobs
Leave the process in 'Waiting' state, it will wait for its children to finish.Resilient
When a Redwood Script process is marked as resilient: When such process is running and the system goes down (for whatever reason, thus the process was not completed), on startup of the system this process is run again.
-
Field Summary
Fields Modifier and Type Field Description static char
DefaultCode
The char returned from Default.getCodeEx().static char
ExternalCode
The char returned from External.getCodeEx().static char
ExternalWaitForChildJobsCode
The char returned from ExternalWaitForChildJobs.getCodeEx().static char
ResilientCode
The char returned from Resilient.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 CompletionStrategyType
safeValueOf(String value)
Helper function to return the CompletionStrategyType represented byvalue
.static CompletionStrategyType
valueOf(char code)
Helper function to return the CompletionStrategyType represented by code.static CompletionStrategyType
valueOf(Character code)
Helper function to return the CompletionStrategyType represented by code.static CompletionStrategyType
valueOf(String name)
Returns the enum constant of this type with the specified name.static CompletionStrategyType
valueOfCode(String code)
Helper function to return the CompletionStrategyType represented by code.static CompletionStrategyType[]
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
-
Default
public static final CompletionStrategyType Default
Set the process to a final status when the process-thread/process finishes executing.
-
External
public static final CompletionStrategyType External
Leave the process in 'Running' state, its status will be updated externally.
-
ExternalWaitForChildJobs
public static final CompletionStrategyType ExternalWaitForChildJobs
Leave the process in 'Waiting' state, it will wait for its children to finish.
-
Resilient
public static final CompletionStrategyType Resilient
When a Redwood Script process is marked as resilient: When such process is running and the system goes down (for whatever reason, thus the process was not completed), on startup of the system this process is run again. It is the developer's responsibility to properly deal with potentially multiple runs of this process.
-
-
Field Detail
-
DefaultCode
public static final char DefaultCode
The char returned from Default.getCodeEx().- See Also:
Default
, Constant Field Values
-
ExternalCode
public static final char ExternalCode
The char returned from External.getCodeEx().- See Also:
External
, Constant Field Values
-
ExternalWaitForChildJobsCode
public static final char ExternalWaitForChildJobsCode
The char returned from ExternalWaitForChildJobs.getCodeEx().- See Also:
ExternalWaitForChildJobs
, Constant Field Values
-
ResilientCode
public static final char ResilientCode
The char returned from Resilient.getCodeEx().- See Also:
Resilient
, Constant Field Values
-
-
Method Detail
-
values
public static CompletionStrategyType[] 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 (CompletionStrategyType c : CompletionStrategyType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static CompletionStrategyType 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 CompletionStrategyType valueOfCode(String code)
Helper function to return the CompletionStrategyType 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 CompletionStrategyType- Returns:
- The CompletionStrategyType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static CompletionStrategyType safeValueOf(String value)
Helper function to return the CompletionStrategyType represented byvalue
. Ifvalue
is null, or not a valid CompletionStrategyType 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 CompletionStrategyType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static CompletionStrategyType valueOf(Character code)
Helper function to return the CompletionStrategyType represented by code. If code is null, or not a valid CompletionStrategyType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The CompletionStrategyType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static CompletionStrategyType valueOf(char code)
Helper function to return the CompletionStrategyType represented by code. If code is not a valid CompletionStrategyType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The CompletionStrategyType 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<CompletionStrategyType>
- 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<CompletionStrategyType,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<CompletionStrategyType>
- 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<CompletionStrategyType,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<CompletionStrategyType,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<CompletionStrategyType,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<CompletionStrategyType>
- Returns:
- the database code for the enumeration
-
-