Enum ActionWorkType
- java.lang.Object
-
- java.lang.Enum<ActionWorkType>
-
- com.redwood.scheduler.api.model.enumeration.ActionWorkType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ActionWorkType,Character>
,SchedulerEnumeration<ActionWorkType>
,Serializable
,Comparable<ActionWorkType>
public enum ActionWorkType extends Enum<ActionWorkType> implements SchedulerEnumeration<ActionWorkType>
The status of a work action in the Action Component work list. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AlertEscalationPostAction
Work for an AlertEscalationAction to perform after an alert has been escalated .AlertSourcePostAction
Work for an AlertSourceAction to perform after a AlertSourceAlert alert has been performed.CatalogReferenceAction
Update References for catalog components.CleanUpJobFileAction
Work to clean up files.CredentialTraceAction
Credential tracing not done in another actionEscalationAction
Escalate an alert.EventComponentCheckAction
Work that will run and check for process that was handled by EventComponent and asked to be placed into special HELD state.FinalizeSleepJobAction
Finalize Sleep jobsJobDefinitionAlertAction
Work for a process definition alert action.MonitorAlertAction
Work for a monitor alert action.OnChangeAction
Work for an on-change action.OperatorMessageAction
Work for an operator messagePostRunningAction
Work for a post-running action.PreRunningAction
Work for a pre-running action.ProcessServerAlertAction
Work for a process server alert action.ProcessServerRestartAction
Restart a process server with a timeout.QueueAlertAction
Work for a queue alert action.RescheduleJobGroupAction
Reschedule a recurrence in a separate work action.ResendAlertAction
Work for an alert failure resend action.RestartJobAction
Reschedule a recurrence in a separate work action.RunProcessServerCheckAction
Work that will run ProcessServerCheck and react appropriately to failures.RuntimeExpirationAction
Work for a running action.TimeWindowChangeAction
Update processes and queues that use a changed time window.UpdateFutureJobAction
Update processes after a Process Definition change.UserMessageNotificationAction
Work for a user message notification action.VisualizationUpdateAction
Work for a Visualization update action.
-
Field Summary
Fields Modifier and Type Field Description static char
AlertEscalationPostActionCode
The char returned from AlertEscalationPostAction.getCodeEx().static char
AlertSourcePostActionCode
The char returned from AlertSourcePostAction.getCodeEx().static char
CatalogReferenceActionCode
The char returned from CatalogReferenceAction.getCodeEx().static char
CleanUpJobFileActionCode
The char returned from CleanUpJobFileAction.getCodeEx().static char
CredentialTraceActionCode
The char returned from CredentialTraceAction.getCodeEx().static char
EscalationActionCode
The char returned from EscalationAction.getCodeEx().static char
EventComponentCheckActionCode
The char returned from EventComponentCheckAction.getCodeEx().static char
FinalizeSleepJobActionCode
The char returned from FinalizeSleepJobAction.getCodeEx().static char
JobDefinitionAlertActionCode
The char returned from JobDefinitionAlertAction.getCodeEx().static char
MonitorAlertActionCode
The char returned from MonitorAlertAction.getCodeEx().static char
OnChangeActionCode
The char returned from OnChangeAction.getCodeEx().static char
OperatorMessageActionCode
The char returned from OperatorMessageAction.getCodeEx().static char
PostRunningActionCode
The char returned from PostRunningAction.getCodeEx().static char
PreRunningActionCode
The char returned from PreRunningAction.getCodeEx().static char
ProcessServerAlertActionCode
The char returned from ProcessServerAlertAction.getCodeEx().static char
ProcessServerRestartActionCode
The char returned from ProcessServerRestartAction.getCodeEx().static char
QueueAlertActionCode
The char returned from QueueAlertAction.getCodeEx().static char
RescheduleJobGroupActionCode
The char returned from RescheduleJobGroupAction.getCodeEx().static char
ResendAlertActionCode
The char returned from ResendAlertAction.getCodeEx().static char
RestartJobActionCode
The char returned from RestartJobAction.getCodeEx().static char
RunProcessServerCheckActionCode
The char returned from RunProcessServerCheckAction.getCodeEx().static char
RuntimeExpirationActionCode
The char returned from RuntimeExpirationAction.getCodeEx().static char
TimeWindowChangeActionCode
The char returned from TimeWindowChangeAction.getCodeEx().static char
UpdateFutureJobActionCode
The char returned from UpdateFutureJobAction.getCodeEx().static char
UserMessageNotificationActionCode
The char returned from UserMessageNotificationAction.getCodeEx().static char
VisualizationUpdateActionCode
The char returned from VisualizationUpdateAction.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
getLogFileName()
long
getLogFileOrder()
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 ActionWorkType
safeValueOf(String value)
Helper function to return the ActionWorkType represented byvalue
.static ActionWorkType
valueOf(char code)
Helper function to return the ActionWorkType represented by code.static ActionWorkType
valueOf(Character code)
Helper function to return the ActionWorkType represented by code.static ActionWorkType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ActionWorkType
valueOfCode(String code)
Helper function to return the ActionWorkType represented by code.static ActionWorkType[]
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
-
OnChangeAction
public static final ActionWorkType OnChangeAction
Work for an on-change action.
-
PreRunningAction
public static final ActionWorkType PreRunningAction
Work for a pre-running action.
-
PostRunningAction
public static final ActionWorkType PostRunningAction
Work for a post-running action.
-
JobDefinitionAlertAction
public static final ActionWorkType JobDefinitionAlertAction
Work for a process definition alert action.
-
EscalationAction
public static final ActionWorkType EscalationAction
Escalate an alert.
-
ProcessServerAlertAction
public static final ActionWorkType ProcessServerAlertAction
Work for a process server alert action.
-
RuntimeExpirationAction
public static final ActionWorkType RuntimeExpirationAction
Work for a running action.
-
QueueAlertAction
public static final ActionWorkType QueueAlertAction
Work for a queue alert action.
-
ResendAlertAction
public static final ActionWorkType ResendAlertAction
Work for an alert failure resend action.
-
AlertEscalationPostAction
public static final ActionWorkType AlertEscalationPostAction
Work for an AlertEscalationAction to perform after an alert has been escalated .
-
AlertSourcePostAction
public static final ActionWorkType AlertSourcePostAction
Work for an AlertSourceAction to perform after a AlertSourceAlert alert has been performed.
-
OperatorMessageAction
public static final ActionWorkType OperatorMessageAction
Work for an operator message
-
MonitorAlertAction
public static final ActionWorkType MonitorAlertAction
Work for a monitor alert action.
-
RescheduleJobGroupAction
public static final ActionWorkType RescheduleJobGroupAction
Reschedule a recurrence in a separate work action.
-
RestartJobAction
public static final ActionWorkType RestartJobAction
Reschedule a recurrence in a separate work action.
-
UserMessageNotificationAction
public static final ActionWorkType UserMessageNotificationAction
Work for a user message notification action.
-
VisualizationUpdateAction
public static final ActionWorkType VisualizationUpdateAction
Work for a Visualization update action.
-
RunProcessServerCheckAction
public static final ActionWorkType RunProcessServerCheckAction
Work that will run ProcessServerCheck and react appropriately to failures.
-
EventComponentCheckAction
public static final ActionWorkType EventComponentCheckAction
Work that will run and check for process that was handled by EventComponent and asked to be placed into special HELD state. This will release the process when needed.
-
TimeWindowChangeAction
public static final ActionWorkType TimeWindowChangeAction
Update processes and queues that use a changed time window.
-
UpdateFutureJobAction
public static final ActionWorkType UpdateFutureJobAction
Update processes after a Process Definition change.
-
ProcessServerRestartAction
public static final ActionWorkType ProcessServerRestartAction
Restart a process server with a timeout.
-
CleanUpJobFileAction
public static final ActionWorkType CleanUpJobFileAction
Work to clean up files.
-
CredentialTraceAction
public static final ActionWorkType CredentialTraceAction
Credential tracing not done in another action
-
FinalizeSleepJobAction
public static final ActionWorkType FinalizeSleepJobAction
Finalize Sleep jobs
-
CatalogReferenceAction
public static final ActionWorkType CatalogReferenceAction
Update References for catalog components.
-
-
Field Detail
-
OnChangeActionCode
public static final char OnChangeActionCode
The char returned from OnChangeAction.getCodeEx().- See Also:
OnChangeAction
, Constant Field Values
-
PreRunningActionCode
public static final char PreRunningActionCode
The char returned from PreRunningAction.getCodeEx().- See Also:
PreRunningAction
, Constant Field Values
-
PostRunningActionCode
public static final char PostRunningActionCode
The char returned from PostRunningAction.getCodeEx().- See Also:
PostRunningAction
, Constant Field Values
-
JobDefinitionAlertActionCode
public static final char JobDefinitionAlertActionCode
The char returned from JobDefinitionAlertAction.getCodeEx().- See Also:
JobDefinitionAlertAction
, Constant Field Values
-
EscalationActionCode
public static final char EscalationActionCode
The char returned from EscalationAction.getCodeEx().- See Also:
EscalationAction
, Constant Field Values
-
ProcessServerAlertActionCode
public static final char ProcessServerAlertActionCode
The char returned from ProcessServerAlertAction.getCodeEx().- See Also:
ProcessServerAlertAction
, Constant Field Values
-
RuntimeExpirationActionCode
public static final char RuntimeExpirationActionCode
The char returned from RuntimeExpirationAction.getCodeEx().- See Also:
RuntimeExpirationAction
, Constant Field Values
-
QueueAlertActionCode
public static final char QueueAlertActionCode
The char returned from QueueAlertAction.getCodeEx().- See Also:
QueueAlertAction
, Constant Field Values
-
ResendAlertActionCode
public static final char ResendAlertActionCode
The char returned from ResendAlertAction.getCodeEx().- See Also:
ResendAlertAction
, Constant Field Values
-
AlertEscalationPostActionCode
public static final char AlertEscalationPostActionCode
The char returned from AlertEscalationPostAction.getCodeEx().- See Also:
AlertEscalationPostAction
, Constant Field Values
-
AlertSourcePostActionCode
public static final char AlertSourcePostActionCode
The char returned from AlertSourcePostAction.getCodeEx().- See Also:
AlertSourcePostAction
, Constant Field Values
-
OperatorMessageActionCode
public static final char OperatorMessageActionCode
The char returned from OperatorMessageAction.getCodeEx().- See Also:
OperatorMessageAction
, Constant Field Values
-
MonitorAlertActionCode
public static final char MonitorAlertActionCode
The char returned from MonitorAlertAction.getCodeEx().- See Also:
MonitorAlertAction
, Constant Field Values
-
RescheduleJobGroupActionCode
public static final char RescheduleJobGroupActionCode
The char returned from RescheduleJobGroupAction.getCodeEx().- See Also:
RescheduleJobGroupAction
, Constant Field Values
-
RestartJobActionCode
public static final char RestartJobActionCode
The char returned from RestartJobAction.getCodeEx().- See Also:
RestartJobAction
, Constant Field Values
-
UserMessageNotificationActionCode
public static final char UserMessageNotificationActionCode
The char returned from UserMessageNotificationAction.getCodeEx().
-
VisualizationUpdateActionCode
public static final char VisualizationUpdateActionCode
The char returned from VisualizationUpdateAction.getCodeEx().- See Also:
VisualizationUpdateAction
, Constant Field Values
-
RunProcessServerCheckActionCode
public static final char RunProcessServerCheckActionCode
The char returned from RunProcessServerCheckAction.getCodeEx().- See Also:
RunProcessServerCheckAction
, Constant Field Values
-
EventComponentCheckActionCode
public static final char EventComponentCheckActionCode
The char returned from EventComponentCheckAction.getCodeEx().- See Also:
EventComponentCheckAction
, Constant Field Values
-
TimeWindowChangeActionCode
public static final char TimeWindowChangeActionCode
The char returned from TimeWindowChangeAction.getCodeEx().- See Also:
TimeWindowChangeAction
, Constant Field Values
-
UpdateFutureJobActionCode
public static final char UpdateFutureJobActionCode
The char returned from UpdateFutureJobAction.getCodeEx().- See Also:
UpdateFutureJobAction
, Constant Field Values
-
ProcessServerRestartActionCode
public static final char ProcessServerRestartActionCode
The char returned from ProcessServerRestartAction.getCodeEx().- See Also:
ProcessServerRestartAction
, Constant Field Values
-
CleanUpJobFileActionCode
public static final char CleanUpJobFileActionCode
The char returned from CleanUpJobFileAction.getCodeEx().- See Also:
CleanUpJobFileAction
, Constant Field Values
-
CredentialTraceActionCode
public static final char CredentialTraceActionCode
The char returned from CredentialTraceAction.getCodeEx().- See Also:
CredentialTraceAction
, Constant Field Values
-
FinalizeSleepJobActionCode
public static final char FinalizeSleepJobActionCode
The char returned from FinalizeSleepJobAction.getCodeEx().- See Also:
FinalizeSleepJobAction
, Constant Field Values
-
CatalogReferenceActionCode
public static final char CatalogReferenceActionCode
The char returned from CatalogReferenceAction.getCodeEx().- See Also:
CatalogReferenceAction
, Constant Field Values
-
-
Method Detail
-
values
public static ActionWorkType[] 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 (ActionWorkType c : ActionWorkType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ActionWorkType 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
-
getLogFileName
public String getLogFileName()
-
getLogFileOrder
public long getLogFileOrder()
-
valueOfCode
public static ActionWorkType valueOfCode(String code)
Helper function to return the ActionWorkType 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 ActionWorkType- Returns:
- The ActionWorkType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ActionWorkType safeValueOf(String value)
Helper function to return the ActionWorkType represented byvalue
. Ifvalue
is null, or not a valid ActionWorkType 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 ActionWorkType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ActionWorkType valueOf(Character code)
Helper function to return the ActionWorkType represented by code. If code is null, or not a valid ActionWorkType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ActionWorkType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ActionWorkType valueOf(char code)
Helper function to return the ActionWorkType represented by code. If code is not a valid ActionWorkType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ActionWorkType 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<ActionWorkType>
- 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<ActionWorkType,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<ActionWorkType>
- 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<ActionWorkType,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<ActionWorkType,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<ActionWorkType,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<ActionWorkType>
- Returns:
- the database code for the enumeration
-
-