java.lang.Object
- java.lang.Enum<HandlerAction>
- - com.redwood.scheduler.api.model.enumeration.HandlerAction

All Implemented Interfaces:

BaseSchedulerEnumeration<HandlerAction,Character>, SchedulerEnumeration<HandlerAction>, Serializable, Comparable<HandlerAction>
```
public enum HandlerAction
extends Enum<HandlerAction>
implements SchedulerEnumeration<HandlerAction>
```
Possible actions that a StatusHandler can take. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Continue`	Ignore the status and continue with the chain execution.
`GotoStep`	Jump to a specific (numbered) process step in the current chain definition.
`IgnoreJobChainDefault`	Ignore the equivalent default status handler.
`MarkCompleted`	Mark the associated chain or process step as completed.
`RaiseError`	Raise an error with a specific return code and message.
`RequestRestart`	Request a restart by sending a message to the Messages monitor.
`RestartChain`	Restart the chain.
`RestartChainMaster`	Restart the chain with the master Process Definition.
`RestartFailedJobs`	Restart the process step definition after the delay.
`RestartFailedJobsMaster`	Restart the process step definition with the master Process Definition after the delay.
`RestartStep`	Restart the process step.
`RestartStepDelayed`	Restart the process step with the delay specified at the step.
`RestartStepDelayedMaster`	Restart the process step with the master Process Definition with the delay specified at the step.
`RestartStepMaster`	Restart the process step with the master Process Definition.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ContinueCode`	The char returned from Continue.getCodeEx().
`static char`	`GotoStepCode`	The char returned from GotoStep.getCodeEx().
`static char`	`IgnoreJobChainDefaultCode`	The char returned from IgnoreJobChainDefault.getCodeEx().
`static char`	`MarkCompletedCode`	The char returned from MarkCompleted.getCodeEx().
`static char`	`RaiseErrorCode`	The char returned from RaiseError.getCodeEx().
`static char`	`RequestRestartCode`	The char returned from RequestRestart.getCodeEx().
`static char`	`RestartChainCode`	The char returned from RestartChain.getCodeEx().
`static char`	`RestartChainMasterCode`	The char returned from RestartChainMaster.getCodeEx().
`static char`	`RestartFailedJobsCode`	The char returned from RestartFailedJobs.getCodeEx().
`static char`	`RestartFailedJobsMasterCode`	The char returned from RestartFailedJobsMaster.getCodeEx().
`static char`	`RestartStepCode`	The char returned from RestartStep.getCodeEx().
`static char`	`RestartStepDelayedCode`	The char returned from RestartStepDelayed.getCodeEx().
`static char`	`RestartStepDelayedMasterCode`	The char returned from RestartStepDelayedMaster.getCodeEx().
`static char`	`RestartStepMasterCode`	The char returned from RestartStepMaster.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`	`getPopupPath()`	Describes the path to this HandlerAction from the root StatusHandler pop-up menu.
`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 HandlerAction`	`safeValueOf(String value)`	Helper function to return the HandlerAction represented by `value`.
`static HandlerAction`	`valueOf(char code)`	Helper function to return the HandlerAction represented by code.
`static HandlerAction`	`valueOf(Character code)`	Helper function to return the HandlerAction represented by code.
`static HandlerAction`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static HandlerAction`	`valueOfCode(String code)`	Helper function to return the HandlerAction represented by code.
`static HandlerAction[]`	`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal

Methods inherited from interface java.lang.Comparable
compareTo

- Enum Constant Detail
  - Continue
```
public static final HandlerAction Continue
```
    Ignore the status and continue with the chain execution.
  - RequestRestart
```
public static final HandlerAction RequestRestart
```
    Request a restart by sending a message to the Messages monitor.
  - GotoStep
```
public static final HandlerAction GotoStep
```
    Jump to a specific (numbered) process step in the current chain definition.
  - RaiseError
```
public static final HandlerAction RaiseError
```
    Raise an error with a specific return code and message.
  - MarkCompleted
```
public static final HandlerAction MarkCompleted
```
    Mark the associated chain or process step as completed.
  - RestartStep
```
public static final HandlerAction RestartStep
```
    Restart the process step.
  - RestartStepMaster
```
public static final HandlerAction RestartStepMaster
```
    Restart the process step with the master Process Definition.
  - RestartStepDelayed
```
public static final HandlerAction RestartStepDelayed
```
    Restart the process step with the delay specified at the step.
  - RestartStepDelayedMaster
```
public static final HandlerAction RestartStepDelayedMaster
```
    Restart the process step with the master Process Definition with the delay specified at the step.
  - RestartFailedJobs
```
public static final HandlerAction RestartFailedJobs
```
    Restart the process step definition after the delay. This does a restart on error for any call that ran previously: Call was to a normal process definition - just run it again. Call was to a chain definition - run it from point of failure.
  - RestartFailedJobsMaster
```
public static final HandlerAction RestartFailedJobsMaster
```
    Restart the process step definition with the master Process Definition after the delay. This does a restart on error for any call that ran previously: Call was to a normal process definition - just run it again. Call was to a chain definition - run it from point of failure.
  - RestartChain
```
public static final HandlerAction RestartChain
```
    Restart the chain.
  - RestartChainMaster
```
public static final HandlerAction RestartChainMaster
```
    Restart the chain with the master Process Definition.
  - IgnoreJobChainDefault
```
public static final HandlerAction IgnoreJobChainDefault
```
    Ignore the equivalent default status handler. This is an unusual action
- Field Detail
  - ContinueCode
```
public static final char ContinueCode
```
    The char returned from Continue.getCodeEx().
    
    See Also:
    
    Continue, Constant Field Values
  - RequestRestartCode
```
public static final char RequestRestartCode
```
    The char returned from RequestRestart.getCodeEx().
    
    See Also:
    
    RequestRestart, Constant Field Values
  - GotoStepCode
```
public static final char GotoStepCode
```
    The char returned from GotoStep.getCodeEx().
    
    See Also:
    
    GotoStep, Constant Field Values
  - RaiseErrorCode
```
public static final char RaiseErrorCode
```
    The char returned from RaiseError.getCodeEx().
    
    See Also:
    
    RaiseError, Constant Field Values
  - MarkCompletedCode
```
public static final char MarkCompletedCode
```
    The char returned from MarkCompleted.getCodeEx().
    
    See Also:
    
    MarkCompleted, Constant Field Values
  - RestartStepCode
```
public static final char RestartStepCode
```
    The char returned from RestartStep.getCodeEx().
    
    See Also:
    
    RestartStep, Constant Field Values
  - RestartStepMasterCode
```
public static final char RestartStepMasterCode
```
    The char returned from RestartStepMaster.getCodeEx().
    
    See Also:
    
    RestartStepMaster, Constant Field Values
  - RestartStepDelayedCode
```
public static final char RestartStepDelayedCode
```
    The char returned from RestartStepDelayed.getCodeEx().
    
    See Also:
    
    RestartStepDelayed, Constant Field Values
  - RestartStepDelayedMasterCode
```
public static final char RestartStepDelayedMasterCode
```
    The char returned from RestartStepDelayedMaster.getCodeEx().
    
    See Also:
    
    RestartStepDelayedMaster, Constant Field Values
  - RestartFailedJobsCode
```
public static final char RestartFailedJobsCode
```
    The char returned from RestartFailedJobs.getCodeEx().
    
    See Also:
    
    RestartFailedJobs, Constant Field Values
  - RestartFailedJobsMasterCode
```
public static final char RestartFailedJobsMasterCode
```
    The char returned from RestartFailedJobsMaster.getCodeEx().
    
    See Also:
    
    RestartFailedJobsMaster, Constant Field Values
  - RestartChainCode
```
public static final char RestartChainCode
```
    The char returned from RestartChain.getCodeEx().
    
    See Also:
    
    RestartChain, Constant Field Values
  - RestartChainMasterCode
```
public static final char RestartChainMasterCode
```
    The char returned from RestartChainMaster.getCodeEx().
    
    See Also:
    
    RestartChainMaster, Constant Field Values
  - IgnoreJobChainDefaultCode
```
public static final char IgnoreJobChainDefaultCode
```
    The char returned from IgnoreJobChainDefault.getCodeEx().
    
    See Also:
    
    IgnoreJobChainDefault, Constant Field Values
- Method Detail
  - values
```
public static HandlerAction[] 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 (HandlerAction c : HandlerAction.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static HandlerAction 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 name
    
    NullPointerException - if the argument is null
  - getPopupPath
```
public String getPopupPath()
```
    Describes the path to this HandlerAction from the root StatusHandler pop-up menu.
    
    Returns:
    
    the value for PopupPath.
  - valueOfCode
```
public static HandlerAction valueOfCode(String code)
```
    Helper function to return the HandlerAction 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 HandlerAction
    
    Returns:
    
    The HandlerAction corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static HandlerAction safeValueOf(String value)
```
    Helper function to return the HandlerAction represented by value. If value is null, or not a valid HandlerAction 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 invalid value, valueOf(String) will throw an IllegalArgumentException.
    
    Parameters:
    
    value - The string value that corresponds to the requested enumeration value
    
    Returns:
    
    The HandlerAction corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static HandlerAction valueOf(Character code)
```
    Helper function to return the HandlerAction represented by code. If code is null, or not a valid HandlerAction code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The HandlerAction corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static HandlerAction valueOf(char code)
```
    Helper function to return the HandlerAction represented by code. If code is not a valid HandlerAction code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The HandlerAction 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 interface SchedulerEnumeration<HandlerAction>
    
    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 interface BaseSchedulerEnumeration<HandlerAction,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 interface SchedulerEnumeration<HandlerAction>
    
    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 interface BaseSchedulerEnumeration<HandlerAction,Character>
    
    Returns:
    
    the key.
  - getTranslationEN
```
public String getTranslationEN()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the English name of this enumeration.
    
    Specified by:
    
    getTranslationEN in interface BaseSchedulerEnumeration<HandlerAction,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 interface BaseSchedulerEnumeration<HandlerAction,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 interface SchedulerEnumeration<HandlerAction>
    
    Returns:
    
    the database code for the enumeration

Enum HandlerAction

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

Continue

RequestRestart

GotoStep

RaiseError

MarkCompleted

RestartStep

RestartStepMaster

RestartStepDelayed

RestartStepDelayedMaster

RestartFailedJobs

RestartFailedJobsMaster

RestartChain

RestartChainMaster

IgnoreJobChainDefault

Field Detail

ContinueCode

RequestRestartCode

GotoStepCode

RaiseErrorCode

MarkCompletedCode

RestartStepCode

RestartStepMasterCode

RestartStepDelayedCode

RestartStepDelayedMasterCode

RestartFailedJobsCode

RestartFailedJobsMasterCode

RestartChainCode

RestartChainMasterCode

IgnoreJobChainDefaultCode

Method Detail

values

valueOf

getPopupPath

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString