Enum ProcessMonitorLogType
- java.lang.Object
-
- java.lang.Enum<ProcessMonitorLogType>
-
- com.redwood.scheduler.api.model.enumeration.ProcessMonitorLogType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ProcessMonitorLogType,Character>
,SchedulerEnumeration<ProcessMonitorLogType>
,Serializable
,Comparable<ProcessMonitorLogType>
public enum ProcessMonitorLogType extends Enum<ProcessMonitorLogType> implements SchedulerEnumeration<ProcessMonitorLogType>
The type of the log record (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Completed
The ProcessMonitorItem has been finished.Delegated
The UserMessage has been delegated to another user.Error
The ProcessMonitorItem has been finished.Forwarded
The UserMessage has been forwarded to another user.Responded
The UserMessage has been returned to the responsible user.Started
The ProcessMonitorItem has been startedUpdated
The ProcessMonitorItem has been updated.Waiting
The ProcessMonitorItem is waiting on another task.
-
Field Summary
Fields Modifier and Type Field Description static char
CompletedCode
The char returned from Completed.getCodeEx().static char
DelegatedCode
The char returned from Delegated.getCodeEx().static char
ErrorCode
The char returned from Error.getCodeEx().static char
ForwardedCode
The char returned from Forwarded.getCodeEx().static char
RespondedCode
The char returned from Responded.getCodeEx().static char
StartedCode
The char returned from Started.getCodeEx().static char
UpdatedCode
The char returned from Updated.getCodeEx().static char
WaitingCode
The char returned from Waiting.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 ProcessMonitorLogType
safeValueOf(String value)
Helper function to return the ProcessMonitorLogType represented byvalue
.static ProcessMonitorLogType
valueOf(char code)
Helper function to return the ProcessMonitorLogType represented by code.static ProcessMonitorLogType
valueOf(Character code)
Helper function to return the ProcessMonitorLogType represented by code.static ProcessMonitorLogType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ProcessMonitorLogType
valueOfCode(String code)
Helper function to return the ProcessMonitorLogType represented by code.static ProcessMonitorLogType[]
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
-
Started
public static final ProcessMonitorLogType Started
The ProcessMonitorItem has been started
-
Updated
public static final ProcessMonitorLogType Updated
The ProcessMonitorItem has been updated.
-
Completed
public static final ProcessMonitorLogType Completed
The ProcessMonitorItem has been finished.
-
Error
public static final ProcessMonitorLogType Error
The ProcessMonitorItem has been finished.
-
Waiting
public static final ProcessMonitorLogType Waiting
The ProcessMonitorItem is waiting on another task.
-
Delegated
public static final ProcessMonitorLogType Delegated
The UserMessage has been delegated to another user.
-
Forwarded
public static final ProcessMonitorLogType Forwarded
The UserMessage has been forwarded to another user.
-
Responded
public static final ProcessMonitorLogType Responded
The UserMessage has been returned to the responsible user.
-
-
Field Detail
-
StartedCode
public static final char StartedCode
The char returned from Started.getCodeEx().- See Also:
Started
, Constant Field Values
-
UpdatedCode
public static final char UpdatedCode
The char returned from Updated.getCodeEx().- See Also:
Updated
, Constant Field Values
-
CompletedCode
public static final char CompletedCode
The char returned from Completed.getCodeEx().- See Also:
Completed
, Constant Field Values
-
ErrorCode
public static final char ErrorCode
The char returned from Error.getCodeEx().- See Also:
Error
, Constant Field Values
-
WaitingCode
public static final char WaitingCode
The char returned from Waiting.getCodeEx().- See Also:
Waiting
, Constant Field Values
-
DelegatedCode
public static final char DelegatedCode
The char returned from Delegated.getCodeEx().- See Also:
Delegated
, Constant Field Values
-
ForwardedCode
public static final char ForwardedCode
The char returned from Forwarded.getCodeEx().- See Also:
Forwarded
, Constant Field Values
-
RespondedCode
public static final char RespondedCode
The char returned from Responded.getCodeEx().- See Also:
Responded
, Constant Field Values
-
-
Method Detail
-
values
public static ProcessMonitorLogType[] 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 (ProcessMonitorLogType c : ProcessMonitorLogType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ProcessMonitorLogType 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 ProcessMonitorLogType valueOfCode(String code)
Helper function to return the ProcessMonitorLogType 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 ProcessMonitorLogType- Returns:
- The ProcessMonitorLogType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ProcessMonitorLogType safeValueOf(String value)
Helper function to return the ProcessMonitorLogType represented byvalue
. Ifvalue
is null, or not a valid ProcessMonitorLogType 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 ProcessMonitorLogType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ProcessMonitorLogType valueOf(Character code)
Helper function to return the ProcessMonitorLogType represented by code. If code is null, or not a valid ProcessMonitorLogType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ProcessMonitorLogType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ProcessMonitorLogType valueOf(char code)
Helper function to return the ProcessMonitorLogType represented by code. If code is not a valid ProcessMonitorLogType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ProcessMonitorLogType 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<ProcessMonitorLogType>
- 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<ProcessMonitorLogType,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<ProcessMonitorLogType>
- 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<ProcessMonitorLogType,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<ProcessMonitorLogType,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<ProcessMonitorLogType,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<ProcessMonitorLogType>
- Returns:
- the database code for the enumeration
-
-