Enum ReactionJobType
- java.lang.Object
-
- java.lang.Enum<ReactionJobType>
-
- com.redwood.scheduler.api.model.enumeration.ReactionJobType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ReactionJobType,Character>
,SchedulerEnumeration<ReactionJobType>
,Serializable
,Comparable<ReactionJobType>
public enum ReactionJobType extends Enum<ReactionJobType> implements SchedulerEnumeration<ReactionJobType>
The style of a Reaction Job check. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Any
A general reaction process that will react to any situationCheck
Reacts to the failure of a Process Server CheckPromoteFurtherPusher
A reaction process that will promote an existing car file to the next remote systemPushAcceptor
A reaction process that will handle an incoming promotePusher
A reaction process that will push a car file to a remote system
-
Field Summary
Fields Modifier and Type Field Description static char
AnyCode
The char returned from Any.getCodeEx().static char
CheckCode
The char returned from Check.getCodeEx().static char
PromoteFurtherPusherCode
The char returned from PromoteFurtherPusher.getCodeEx().static char
PushAcceptorCode
The char returned from PushAcceptor.getCodeEx().static char
PusherCode
The char returned from Pusher.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 ReactionJobType
safeValueOf(String value)
Helper function to return the ReactionJobType represented byvalue
.static ReactionJobType
valueOf(char code)
Helper function to return the ReactionJobType represented by code.static ReactionJobType
valueOf(Character code)
Helper function to return the ReactionJobType represented by code.static ReactionJobType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ReactionJobType
valueOfCode(String code)
Helper function to return the ReactionJobType represented by code.static ReactionJobType[]
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
-
Check
public static final ReactionJobType Check
Reacts to the failure of a Process Server Check
-
Any
public static final ReactionJobType Any
A general reaction process that will react to any situation
-
Pusher
public static final ReactionJobType Pusher
A reaction process that will push a car file to a remote system
-
PushAcceptor
public static final ReactionJobType PushAcceptor
A reaction process that will handle an incoming promote
-
PromoteFurtherPusher
public static final ReactionJobType PromoteFurtherPusher
A reaction process that will promote an existing car file to the next remote system
-
-
Field Detail
-
CheckCode
public static final char CheckCode
The char returned from Check.getCodeEx().- See Also:
Check
, Constant Field Values
-
AnyCode
public static final char AnyCode
The char returned from Any.getCodeEx().- See Also:
Any
, Constant Field Values
-
PusherCode
public static final char PusherCode
The char returned from Pusher.getCodeEx().- See Also:
Pusher
, Constant Field Values
-
PushAcceptorCode
public static final char PushAcceptorCode
The char returned from PushAcceptor.getCodeEx().- See Also:
PushAcceptor
, Constant Field Values
-
PromoteFurtherPusherCode
public static final char PromoteFurtherPusherCode
The char returned from PromoteFurtherPusher.getCodeEx().- See Also:
PromoteFurtherPusher
, Constant Field Values
-
-
Method Detail
-
values
public static ReactionJobType[] 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 (ReactionJobType c : ReactionJobType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ReactionJobType 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 ReactionJobType valueOfCode(String code)
Helper function to return the ReactionJobType 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 ReactionJobType- Returns:
- The ReactionJobType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ReactionJobType safeValueOf(String value)
Helper function to return the ReactionJobType represented byvalue
. Ifvalue
is null, or not a valid ReactionJobType 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 ReactionJobType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ReactionJobType valueOf(Character code)
Helper function to return the ReactionJobType represented by code. If code is null, or not a valid ReactionJobType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ReactionJobType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ReactionJobType valueOf(char code)
Helper function to return the ReactionJobType represented by code. If code is not a valid ReactionJobType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ReactionJobType 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<ReactionJobType>
- 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<ReactionJobType,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<ReactionJobType>
- 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<ReactionJobType,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<ReactionJobType,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<ReactionJobType,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<ReactionJobType>
- Returns:
- the database code for the enumeration
-
-