Enum TableParameterType
- java.lang.Object
-
- java.lang.Enum<TableParameterType>
-
- com.redwood.scheduler.api.model.enumeration.TableParameterType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<TableParameterType,Character>
,SchedulerEnumeration<TableParameterType>
,Serializable
,Comparable<TableParameterType>
public enum TableParameterType extends Enum<TableParameterType> implements SchedulerEnumeration<TableParameterType>
The type of the TableParameter. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Inline
The TableParameter data is written or modified in the Parameter itself.JobFile
The TableParameter data is retrieved from a Process File.RelativeFile
The TableParameter data is retrieved from a Process File.Table
The TableParameter data is retrieved from a Table object.
-
Field Summary
Fields Modifier and Type Field Description static char
InlineCode
The char returned from Inline.getCodeEx().static char
JobFileCode
The char returned from JobFile.getCodeEx().static char
RelativeFileCode
The char returned from RelativeFile.getCodeEx().static char
TableCode
The char returned from Table.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 TableParameterType
safeValueOf(String value)
Helper function to return the TableParameterType represented byvalue
.static TableParameterType
valueOf(char code)
Helper function to return the TableParameterType represented by code.static TableParameterType
valueOf(Character code)
Helper function to return the TableParameterType represented by code.static TableParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static TableParameterType
valueOfCode(String code)
Helper function to return the TableParameterType represented by code.static TableParameterType[]
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
-
Inline
public static final TableParameterType Inline
The TableParameter data is written or modified in the Parameter itself. The text is expected to be valid RT XML
-
JobFile
public static final TableParameterType JobFile
The TableParameter data is retrieved from a Process File.
-
RelativeFile
public static final TableParameterType RelativeFile
The TableParameter data is retrieved from a Process File.
-
Table
public static final TableParameterType Table
The TableParameter data is retrieved from a Table object.
-
-
Field Detail
-
InlineCode
public static final char InlineCode
The char returned from Inline.getCodeEx().- See Also:
Inline
, Constant Field Values
-
JobFileCode
public static final char JobFileCode
The char returned from JobFile.getCodeEx().- See Also:
JobFile
, Constant Field Values
-
RelativeFileCode
public static final char RelativeFileCode
The char returned from RelativeFile.getCodeEx().- See Also:
RelativeFile
, Constant Field Values
-
TableCode
public static final char TableCode
The char returned from Table.getCodeEx().- See Also:
Table
, Constant Field Values
-
-
Method Detail
-
values
public static TableParameterType[] 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 (TableParameterType c : TableParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TableParameterType 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 TableParameterType valueOfCode(String code)
Helper function to return the TableParameterType 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 TableParameterType- Returns:
- The TableParameterType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static TableParameterType safeValueOf(String value)
Helper function to return the TableParameterType represented byvalue
. Ifvalue
is null, or not a valid TableParameterType 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 TableParameterType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static TableParameterType valueOf(Character code)
Helper function to return the TableParameterType represented by code. If code is null, or not a valid TableParameterType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The TableParameterType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static TableParameterType valueOf(char code)
Helper function to return the TableParameterType represented by code. If code is not a valid TableParameterType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The TableParameterType 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<TableParameterType>
- 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<TableParameterType,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<TableParameterType>
- 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<TableParameterType,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<TableParameterType,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<TableParameterType,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<TableParameterType>
- Returns:
- the database code for the enumeration
-
-