Enum ParameterMappingType
- java.lang.Object
-
- java.lang.Enum<ParameterMappingType>
-
- com.redwood.scheduler.api.model.enumeration.ParameterMappingType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ParameterMappingType,Integer>
,SchedulerIntegerEnumeration<ParameterMappingType>
,Serializable
,Comparable<ParameterMappingType>
public enum ParameterMappingType extends Enum<ParameterMappingType> implements SchedulerIntegerEnumeration<ParameterMappingType>
The mapping type for parameters. Used by the JobChain editor. (Integer Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Generated
Deprecated.This enumeration constant is deprecated, we no longer automatically delete parameter mappingsNormal
Normal parameter.PassThrough
Hidden generated parameter on a sub Chain Definition.
-
Field Summary
Fields Modifier and Type Field Description static int
GeneratedCode
Deprecated.static int
NormalCode
The int returned from Normal.getCodeEx().static int
PassThroughCode
The int returned from PassThrough.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getCodeEx()
Get the code that is used to represent this enumeration in the database.Integer
getCodeExInteger()
Get the code that is used to represent this enumeration in the database.Integer
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 ParameterMappingType
safeValueOf(String value)
Helper function to return the ParameterMappingType represented byvalue
.static ParameterMappingType
valueOf(int code)
Helper function to return the ParameterMappingType represented by code.static ParameterMappingType
valueOf(Integer code)
Helper function to return the ParameterMappingType represented by code.static ParameterMappingType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ParameterMappingType
valueOfCode(String code)
Helper function to return the ParameterMappingType represented by code.static ParameterMappingType[]
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
-
Normal
public static final ParameterMappingType Normal
Normal parameter. The parameter will not be deleted by the Chain Definition editor.
-
Generated
@Deprecated public static final ParameterMappingType Generated
Deprecated.This enumeration constant is deprecated, we no longer automatically delete parameter mappingsVisible generated parameter on a root Chain Definition. The parameter may be deleted by the Chain Definition editor when it's no longer in use.
-
PassThrough
public static final ParameterMappingType PassThrough
Hidden generated parameter on a sub Chain Definition. Purpose of this parameter is to enable cross chain parameter mappings. The parameter may be deleted by the Chain Definition editor when it's no longer in use.
-
-
Field Detail
-
NormalCode
public static final int NormalCode
The int returned from Normal.getCodeEx().- See Also:
Normal
, Constant Field Values
-
GeneratedCode
@Deprecated public static final int GeneratedCode
Deprecated.The int returned from Generated.getCodeEx().
-
PassThroughCode
public static final int PassThroughCode
The int returned from PassThrough.getCodeEx().- See Also:
PassThrough
, Constant Field Values
-
-
Method Detail
-
values
public static ParameterMappingType[] 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 (ParameterMappingType c : ParameterMappingType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ParameterMappingType 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 ParameterMappingType valueOfCode(String code)
Helper function to return the ParameterMappingType represented by code. If code is null, empty, or not a valid code then this method will return null.- Parameters:
code
- A string that is one of the codes for ParameterMappingType- Returns:
- The ParameterMappingType corresponding to code, or null.
-
safeValueOf
public static ParameterMappingType safeValueOf(String value)
Helper function to return the ParameterMappingType represented byvalue
. Ifvalue
is null, or not a valid ParameterMappingType 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 ParameterMappingType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ParameterMappingType valueOf(Integer code)
Helper function to return the ParameterMappingType represented by code. If code is null, or not a valid ParameterMappingType code then this method will return null.- Parameters:
code
- Integer that is one of the codes for HandlerAction- Returns:
- The ParameterMappingType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ParameterMappingType valueOf(int code)
Helper function to return the ParameterMappingType represented by code. If code is not a valid ParameterMappingType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ParameterMappingType corresponding to code, or null, if code is not a valid code
-
getCodeEx
public int getCodeEx()
Description copied from interface:SchedulerIntegerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerIntegerEnumeration<ParameterMappingType>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Integer 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<ParameterMappingType,Integer>
- Returns:
- the enumeration code
-
getCodeExInteger
public Integer getCodeExInteger()
Description copied from interface:SchedulerIntegerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExInteger
in interfaceSchedulerIntegerEnumeration<ParameterMappingType>
- 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<ParameterMappingType,Integer>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<ParameterMappingType,Integer>
- 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<ParameterMappingType,Integer>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
-