Enum NotificationType
- java.lang.Object
-
- java.lang.Enum<NotificationType>
-
- com.redwood.scheduler.api.model.enumeration.NotificationType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<NotificationType,Integer>
,SchedulerIntegerEnumeration<NotificationType>
,Serializable
,Comparable<NotificationType>
public enum NotificationType extends Enum<NotificationType> implements SchedulerIntegerEnumeration<NotificationType>
The notification type to that determines how much a user is notified via email. (Integer Enumeration)
-
-
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
getStringValue()
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 NotificationType
safeValueOf(String value)
Helper function to return the NotificationType represented byvalue
.static NotificationType
valueOf(int code)
Helper function to return the NotificationType represented by code.static NotificationType
valueOf(Integer code)
Helper function to return the NotificationType represented by code.static NotificationType
valueOf(String name)
Returns the enum constant of this type with the specified name.static NotificationType
valueOfCode(String code)
Helper function to return the NotificationType represented by code.static NotificationType[]
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
-
None
public static final NotificationType None
No notifications are sent
-
All
public static final NotificationType All
All notifications are sent
-
-
Field Detail
-
NoneCode
public static final int NoneCode
The int returned from None.getCodeEx().- See Also:
None
, Constant Field Values
-
AllCode
public static final int AllCode
The int returned from All.getCodeEx().- See Also:
All
, Constant Field Values
-
-
Method Detail
-
values
public static NotificationType[] 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 (NotificationType c : NotificationType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NotificationType 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
-
getStringValue
public String getStringValue()
-
valueOfCode
public static NotificationType valueOfCode(String code)
Helper function to return the NotificationType 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 NotificationType- Returns:
- The NotificationType corresponding to code, or null.
-
safeValueOf
public static NotificationType safeValueOf(String value)
Helper function to return the NotificationType represented byvalue
. Ifvalue
is null, or not a valid NotificationType 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 NotificationType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static NotificationType valueOf(Integer code)
Helper function to return the NotificationType represented by code. If code is null, or not a valid NotificationType code then this method will return null.- Parameters:
code
- Integer that is one of the codes for HandlerAction- Returns:
- The NotificationType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static NotificationType valueOf(int code)
Helper function to return the NotificationType represented by code. If code is not a valid NotificationType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The NotificationType 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<NotificationType>
- 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<NotificationType,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<NotificationType>
- 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<NotificationType,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<NotificationType,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<NotificationType,Integer>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
-