Enum SAPMassActivityParameterType
- java.lang.Object
-
- java.lang.Enum<SAPMassActivityParameterType>
-
- com.redwood.scheduler.api.model.enumeration.SAPMassActivityParameterType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SAPMassActivityParameterType,Character>
,SchedulerEnumeration<SAPMassActivityParameterType>
,Serializable
,Comparable<SAPMassActivityParameterType>
public enum SAPMassActivityParameterType extends Enum<SAPMassActivityParameterType> implements SchedulerEnumeration<SAPMassActivityParameterType>
Type of a mass activity parameter. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Date
Date (as DateTimeZone)Number
Number: INT1, INT2, INT4Numc
NUMC: character field that accepts only numbersObject
Mass Activity objectOption
Option of a select optionSign
Sign of a select option: I / EString
StringStructure
StructureTable
TableTime
Time (as DateTimeZone)Variant
Mass Activity variant
-
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
NumcCode
The char returned from Numc.getCodeEx().static char
ObjectCode
The char returned from Object.getCodeEx().static char
OptionCode
The char returned from Option.getCodeEx().static char
SignCode
The char returned from Sign.getCodeEx().static char
StringCode
The char returned from String.getCodeEx().static char
StructureCode
The char returned from Structure.getCodeEx().static char
TableCode
The char returned from Table.getCodeEx().static char
TimeCode
The char returned from Time.getCodeEx().static char
VariantCode
The char returned from Variant.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 SAPMassActivityParameterType
safeValueOf(String value)
Helper function to return the SAPMassActivityParameterType represented byvalue
.static SAPMassActivityParameterType
valueOf(char code)
Helper function to return the SAPMassActivityParameterType represented by code.static SAPMassActivityParameterType
valueOf(Character code)
Helper function to return the SAPMassActivityParameterType represented by code.static SAPMassActivityParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static SAPMassActivityParameterType
valueOfCode(String code)
Helper function to return the SAPMassActivityParameterType represented by code.static SAPMassActivityParameterType[]
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
-
Numc
public static final SAPMassActivityParameterType Numc
NUMC: character field that accepts only numbers
-
Date
public static final SAPMassActivityParameterType Date
Date (as DateTimeZone)
-
String
public static final SAPMassActivityParameterType String
String
-
Sign
public static final SAPMassActivityParameterType Sign
Sign of a select option: I / E
-
Object
public static final SAPMassActivityParameterType Object
Mass Activity object
-
Time
public static final SAPMassActivityParameterType Time
Time (as DateTimeZone)
-
Number
public static final SAPMassActivityParameterType Number
Number: INT1, INT2, INT4
-
Option
public static final SAPMassActivityParameterType Option
Option of a select option
-
Structure
public static final SAPMassActivityParameterType Structure
Structure
-
Table
public static final SAPMassActivityParameterType Table
Table
-
Variant
public static final SAPMassActivityParameterType Variant
Mass Activity variant
-
-
Field Detail
-
NumcCode
public static final char NumcCode
The char returned from Numc.getCodeEx().- See Also:
Numc
, Constant Field Values
-
DateCode
public static final char DateCode
The char returned from Date.getCodeEx().- See Also:
Date
, Constant Field Values
-
StringCode
public static final char StringCode
The char returned from String.getCodeEx().- See Also:
String
, Constant Field Values
-
SignCode
public static final char SignCode
The char returned from Sign.getCodeEx().- See Also:
Sign
, Constant Field Values
-
ObjectCode
public static final char ObjectCode
The char returned from Object.getCodeEx().- See Also:
Object
, 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
-
OptionCode
public static final char OptionCode
The char returned from Option.getCodeEx().- See Also:
Option
, Constant Field Values
-
StructureCode
public static final char StructureCode
The char returned from Structure.getCodeEx().- See Also:
Structure
, Constant Field Values
-
TableCode
public static final char TableCode
The char returned from Table.getCodeEx().- See Also:
Table
, Constant Field Values
-
VariantCode
public static final char VariantCode
The char returned from Variant.getCodeEx().- See Also:
Variant
, Constant Field Values
-
-
Method Detail
-
values
public static SAPMassActivityParameterType[] 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 (SAPMassActivityParameterType c : SAPMassActivityParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SAPMassActivityParameterType 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 SAPMassActivityParameterType valueOfCode(String code)
Helper function to return the SAPMassActivityParameterType 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 SAPMassActivityParameterType- Returns:
- The SAPMassActivityParameterType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SAPMassActivityParameterType safeValueOf(String value)
Helper function to return the SAPMassActivityParameterType represented byvalue
. Ifvalue
is null, or not a valid SAPMassActivityParameterType 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 SAPMassActivityParameterType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SAPMassActivityParameterType valueOf(Character code)
Helper function to return the SAPMassActivityParameterType represented by code. If code is null, or not a valid SAPMassActivityParameterType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The SAPMassActivityParameterType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SAPMassActivityParameterType valueOf(char code)
Helper function to return the SAPMassActivityParameterType represented by code. If code is not a valid SAPMassActivityParameterType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The SAPMassActivityParameterType 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<SAPMassActivityParameterType>
- 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<SAPMassActivityParameterType,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<SAPMassActivityParameterType>
- 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<SAPMassActivityParameterType,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<SAPMassActivityParameterType,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<SAPMassActivityParameterType,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<SAPMassActivityParameterType>
- Returns:
- the database code for the enumeration
-
-