Enum SAPAbapProgramParameterType
- java.lang.Object
-
- java.lang.Enum<SAPAbapProgramParameterType>
-
- com.redwood.scheduler.api.model.enumeration.SAPAbapProgramParameterType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SAPAbapProgramParameterType,Character>
,SchedulerEnumeration<SAPAbapProgramParameterType>
,Serializable
,Comparable<SAPAbapProgramParameterType>
public enum SAPAbapProgramParameterType extends Enum<SAPAbapProgramParameterType> implements SchedulerEnumeration<SAPAbapProgramParameterType>
Type of an ABAP parameter. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Date
Date.Number
Number.RadioButton
Radio button.String
String.Time
Time.
-
Field Summary
Fields Modifier and Type Field Description static char
DateCode
The char returned from Date.getCodeEx().static char
NumberCode
The char returned from Number.getCodeEx().static char
RadioButtonCode
The char returned from RadioButton.getCodeEx().static char
StringCode
The char returned from String.getCodeEx().static char
TimeCode
The char returned from Time.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 SAPAbapProgramParameterType
safeValueOf(String value)
Helper function to return the SAPAbapProgramParameterType represented byvalue
.static SAPAbapProgramParameterType
valueOf(char code)
Helper function to return the SAPAbapProgramParameterType represented by code.static SAPAbapProgramParameterType
valueOf(Character code)
Helper function to return the SAPAbapProgramParameterType represented by code.static SAPAbapProgramParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SAPAbapProgramParameterType
valueOfCode(String code)
Helper function to return the SAPAbapProgramParameterType represented by code.static SAPAbapProgramParameterType[]
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
-
String
public static final SAPAbapProgramParameterType String
String.
-
Date
public static final SAPAbapProgramParameterType Date
Date.
-
Time
public static final SAPAbapProgramParameterType Time
Time.
-
Number
public static final SAPAbapProgramParameterType Number
Number.
-
RadioButton
public static final SAPAbapProgramParameterType RadioButton
Radio button.
-
-
Field Detail
-
StringCode
public static final char StringCode
The char returned from String.getCodeEx().- See Also:
String
, Constant Field Values
-
DateCode
public static final char DateCode
The char returned from Date.getCodeEx().- See Also:
Date
, Constant Field Values
-
TimeCode
public static final char TimeCode
The char returned from Time.getCodeEx().- See Also:
Time
, Constant Field Values
-
NumberCode
public static final char NumberCode
The char returned from Number.getCodeEx().- See Also:
Number
, Constant Field Values
-
RadioButtonCode
public static final char RadioButtonCode
The char returned from RadioButton.getCodeEx().- See Also:
RadioButton
, Constant Field Values
-
-
Method Detail
-
values
public static SAPAbapProgramParameterType[] 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 (SAPAbapProgramParameterType c : SAPAbapProgramParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SAPAbapProgramParameterType 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 SAPAbapProgramParameterType valueOfCode(String code)
Helper function to return the SAPAbapProgramParameterType 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 SAPAbapProgramParameterType- Returns:
- The SAPAbapProgramParameterType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SAPAbapProgramParameterType safeValueOf(String value)
Helper function to return the SAPAbapProgramParameterType represented byvalue
. Ifvalue
is null, or not a valid SAPAbapProgramParameterType 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 SAPAbapProgramParameterType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SAPAbapProgramParameterType valueOf(Character code)
Helper function to return the SAPAbapProgramParameterType represented by code. If code is null, or not a valid SAPAbapProgramParameterType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The SAPAbapProgramParameterType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SAPAbapProgramParameterType valueOf(char code)
Helper function to return the SAPAbapProgramParameterType represented by code. If code is not a valid SAPAbapProgramParameterType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The SAPAbapProgramParameterType 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<SAPAbapProgramParameterType>
- 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<SAPAbapProgramParameterType,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<SAPAbapProgramParameterType>
- 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<SAPAbapProgramParameterType,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<SAPAbapProgramParameterType,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<SAPAbapProgramParameterType,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<SAPAbapProgramParameterType>
- Returns:
- the database code for the enumeration
-
-