Enum JobStatusForJobGroup
- java.lang.Object
-
- java.lang.Enum<JobStatusForJobGroup>
-
- com.redwood.scheduler.api.model.enumeration.JobStatusForJobGroup
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<JobStatusForJobGroup,Character>
,SchedulerEnumeration<JobStatusForJobGroup>
,Serializable
,Comparable<JobStatusForJobGroup>
public enum JobStatusForJobGroup extends Enum<JobStatusForJobGroup> implements SchedulerEnumeration<JobStatusForJobGroup>
The cause that made the job independent from its job group. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Default
The process is part of the recurrenceDelayed
The process was delayed independent from the other processes in the recurrence.Edited
The process was edited independent from the other processes in the recurrence.EditedPersist
Temporary value to mark a modified process that is set to be edited independently that the ProcessStatus must not be changed; this value will be changed to Edited by the preparePhaseHandler.Restarted
The process is a manual restart.RestartedAutomatically
The process is an automatic restart because the Process Definition defines a handler on the Process Status.
-
Field Summary
Fields Modifier and Type Field Description static char
DefaultCode
The char returned from Default.getCodeEx().static char
DelayedCode
The char returned from Delayed.getCodeEx().static char
EditedCode
The char returned from Edited.getCodeEx().static char
EditedPersistCode
The char returned from EditedPersist.getCodeEx().static char
RestartedAutomaticallyCode
The char returned from RestartedAutomatically.getCodeEx().static char
RestartedCode
The char returned from Restarted.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 JobStatusForJobGroup
safeValueOf(String value)
Helper function to return the JobStatusForJobGroup represented byvalue
.static JobStatusForJobGroup
valueOf(char code)
Helper function to return the JobStatusForJobGroup represented by code.static JobStatusForJobGroup
valueOf(Character code)
Helper function to return the JobStatusForJobGroup represented by code.static JobStatusForJobGroup
valueOf(String name)
Returns the enum constant of this type with the specified name.static JobStatusForJobGroup
valueOfCode(String code)
Helper function to return the JobStatusForJobGroup represented by code.static JobStatusForJobGroup[]
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 JobStatusForJobGroup Default
The process is part of the recurrence
-
Delayed
public static final JobStatusForJobGroup Delayed
The process was delayed independent from the other processes in the recurrence.
-
Edited
public static final JobStatusForJobGroup Edited
The process was edited independent from the other processes in the recurrence.
-
EditedPersist
public static final JobStatusForJobGroup EditedPersist
Temporary value to mark a modified process that is set to be edited independently that the ProcessStatus must not be changed; this value will be changed to Edited by the preparePhaseHandler.
-
Restarted
public static final JobStatusForJobGroup Restarted
The process is a manual restart.
-
RestartedAutomatically
public static final JobStatusForJobGroup RestartedAutomatically
The process is an automatic restart because the Process Definition defines a handler on the Process Status.
-
-
Field Detail
-
DefaultCode
public static final char DefaultCode
The char returned from Default.getCodeEx().- See Also:
Default
, Constant Field Values
-
DelayedCode
public static final char DelayedCode
The char returned from Delayed.getCodeEx().- See Also:
Delayed
, Constant Field Values
-
EditedCode
public static final char EditedCode
The char returned from Edited.getCodeEx().- See Also:
Edited
, Constant Field Values
-
EditedPersistCode
public static final char EditedPersistCode
The char returned from EditedPersist.getCodeEx().- See Also:
EditedPersist
, Constant Field Values
-
RestartedCode
public static final char RestartedCode
The char returned from Restarted.getCodeEx().- See Also:
Restarted
, Constant Field Values
-
RestartedAutomaticallyCode
public static final char RestartedAutomaticallyCode
The char returned from RestartedAutomatically.getCodeEx().- See Also:
RestartedAutomatically
, Constant Field Values
-
-
Method Detail
-
values
public static JobStatusForJobGroup[] 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 (JobStatusForJobGroup c : JobStatusForJobGroup.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobStatusForJobGroup 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 JobStatusForJobGroup valueOfCode(String code)
Helper function to return the JobStatusForJobGroup 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 JobStatusForJobGroup- Returns:
- The JobStatusForJobGroup corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static JobStatusForJobGroup safeValueOf(String value)
Helper function to return the JobStatusForJobGroup represented byvalue
. Ifvalue
is null, or not a valid JobStatusForJobGroup 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 JobStatusForJobGroup corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static JobStatusForJobGroup valueOf(Character code)
Helper function to return the JobStatusForJobGroup represented by code. If code is null, or not a valid JobStatusForJobGroup code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The JobStatusForJobGroup corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static JobStatusForJobGroup valueOf(char code)
Helper function to return the JobStatusForJobGroup represented by code. If code is not a valid JobStatusForJobGroup code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The JobStatusForJobGroup 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<JobStatusForJobGroup>
- 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<JobStatusForJobGroup,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<JobStatusForJobGroup>
- 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<JobStatusForJobGroup,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<JobStatusForJobGroup,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<JobStatusForJobGroup,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<JobStatusForJobGroup>
- Returns:
- the database code for the enumeration
-
-