Enum WaitEventSubmitType
- java.lang.Object
-
- java.lang.Enum<WaitEventSubmitType>
-
- com.redwood.scheduler.api.model.enumeration.WaitEventSubmitType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<WaitEventSubmitType,Character>
,SchedulerEnumeration<WaitEventSubmitType>
,Serializable
,Comparable<WaitEventSubmitType>
public enum WaitEventSubmitType extends Enum<WaitEventSubmitType> implements SchedulerEnumeration<WaitEventSubmitType>
Under what conditions should the JobDefinition be submitted when the Event Definition is Raised? (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Always
The Process Definition should always be submitted if the Event Definition is raised.Never
The Process Definition should never be automatically submitted because of this Event Definition.OnlyOne
When the Event Definition is raised, the Process Definition should only be submitted if there is no other Process for this Process Definition where job.getStatus().getState() is New, Initial or Pending.
-
Field Summary
Fields Modifier and Type Field Description static char
AlwaysCode
The char returned from Always.getCodeEx().static char
NeverCode
The char returned from Never.getCodeEx().static char
OnlyOneCode
The char returned from OnlyOne.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 WaitEventSubmitType
safeValueOf(String value)
Helper function to return the WaitEventSubmitType represented byvalue
.static WaitEventSubmitType
valueOf(char code)
Helper function to return the WaitEventSubmitType represented by code.static WaitEventSubmitType
valueOf(Character code)
Helper function to return the WaitEventSubmitType represented by code.static WaitEventSubmitType
valueOf(String name)
Returns the enum constant of this type with the specified name.static WaitEventSubmitType
valueOfCode(String code)
Helper function to return the WaitEventSubmitType represented by code.static WaitEventSubmitType[]
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
-
Never
public static final WaitEventSubmitType Never
The Process Definition should never be automatically submitted because of this Event Definition.
-
Always
public static final WaitEventSubmitType Always
The Process Definition should always be submitted if the Event Definition is raised.
-
OnlyOne
public static final WaitEventSubmitType OnlyOne
When the Event Definition is raised, the Process Definition should only be submitted if there is no other Process for this Process Definition where job.getStatus().getState() is New, Initial or Pending.
-
-
Field Detail
-
NeverCode
public static final char NeverCode
The char returned from Never.getCodeEx().- See Also:
Never
, Constant Field Values
-
AlwaysCode
public static final char AlwaysCode
The char returned from Always.getCodeEx().- See Also:
Always
, Constant Field Values
-
OnlyOneCode
public static final char OnlyOneCode
The char returned from OnlyOne.getCodeEx().- See Also:
OnlyOne
, Constant Field Values
-
-
Method Detail
-
values
public static WaitEventSubmitType[] 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 (WaitEventSubmitType c : WaitEventSubmitType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static WaitEventSubmitType 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 WaitEventSubmitType valueOfCode(String code)
Helper function to return the WaitEventSubmitType 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 WaitEventSubmitType- Returns:
- The WaitEventSubmitType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static WaitEventSubmitType safeValueOf(String value)
Helper function to return the WaitEventSubmitType represented byvalue
. Ifvalue
is null, or not a valid WaitEventSubmitType 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 WaitEventSubmitType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static WaitEventSubmitType valueOf(Character code)
Helper function to return the WaitEventSubmitType represented by code. If code is null, or not a valid WaitEventSubmitType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The WaitEventSubmitType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static WaitEventSubmitType valueOf(char code)
Helper function to return the WaitEventSubmitType represented by code. If code is not a valid WaitEventSubmitType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The WaitEventSubmitType 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<WaitEventSubmitType>
- 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<WaitEventSubmitType,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<WaitEventSubmitType>
- 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<WaitEventSubmitType,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<WaitEventSubmitType,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<WaitEventSubmitType,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<WaitEventSubmitType>
- Returns:
- the database code for the enumeration
-
-