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

All Implemented Interfaces:

BaseSchedulerEnumeration<EventStatus,Character>, SchedulerEnumeration<EventStatus>, Serializable, Comparable<EventStatus>
```
public enum EventStatus
extends Enum<EventStatus>
implements SchedulerEnumeration<EventStatus>
```
Possible states in an Events lifecycle. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Cleared`	The event was raised in the past, but has now been cleared, and is being kept for a historical context, or has been passed to a Process that was waiting on the Event.
`Pending`	The event has been created, via the EventDefinition.raise(), but has not yet been raised by the Event processing engine, either because it has not been processed, or because there is already another Event for the EventDefinition that has been raised.
`PendingRaised`	The eventDefinition is in the process of being raised by the Event Engine.
`Raised`	The event has been raised, and has marked the corresponding Event Definition as having been raised.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ClearedCode`	The char returned from Cleared.getCodeEx().
`static char`	`PendingCode`	The char returned from Pending.getCodeEx().
`static char`	`PendingRaisedCode`	The char returned from PendingRaised.getCodeEx().
`static char`	`RaisedCode`	The char returned from Raised.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 EventStatus`	`safeValueOf(String value)`	Helper function to return the EventStatus represented by `value`.
`static EventStatus`	`valueOf(char code)`	Helper function to return the EventStatus represented by code.
`static EventStatus`	`valueOf(Character code)`	Helper function to return the EventStatus represented by code.
`static EventStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EventStatus`	`valueOfCode(String code)`	Helper function to return the EventStatus represented by code.
`static EventStatus[]`	`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
  - Pending
```
public static final EventStatus Pending
```
    The event has been created, via the EventDefinition.raise(), but has not yet been raised by the Event processing engine, either because it has not been processed, or because there is already another Event for the EventDefinition that has been raised.
  - PendingRaised
```
public static final EventStatus PendingRaised
```
    The eventDefinition is in the process of being raised by the Event Engine.
  - Raised
```
public static final EventStatus Raised
```
    The event has been raised, and has marked the corresponding Event Definition as having been raised. There can be at most one Raised Event per Event Definition at any point in time.
  - Cleared
```
public static final EventStatus Cleared
```
    The event was raised in the past, but has now been cleared, and is being kept for a historical context, or has been passed to a Process that was waiting on the Event.
- Field Detail
  - PendingCode
```
public static final char PendingCode
```
    The char returned from Pending.getCodeEx().
    
    See Also:
    
    Pending, Constant Field Values
  - PendingRaisedCode
```
public static final char PendingRaisedCode
```
    The char returned from PendingRaised.getCodeEx().
    
    See Also:
    
    PendingRaised, Constant Field Values
  - RaisedCode
```
public static final char RaisedCode
```
    The char returned from Raised.getCodeEx().
    
    See Also:
    
    Raised, Constant Field Values
  - ClearedCode
```
public static final char ClearedCode
```
    The char returned from Cleared.getCodeEx().
    
    See Also:
    
    Cleared, Constant Field Values
- Method Detail
  - values
```
public static EventStatus[] 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 (EventStatus c : EventStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EventStatus 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
  - valueOfCode
```
public static EventStatus valueOfCode(String code)
```
    Helper function to return the EventStatus 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 EventStatus
    
    Returns:
    
    The EventStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static EventStatus safeValueOf(String value)
```
    Helper function to return the EventStatus represented by value. If value is null, or not a valid EventStatus 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 EventStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static EventStatus valueOf(Character code)
```
    Helper function to return the EventStatus represented by code. If code is null, or not a valid EventStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The EventStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static EventStatus valueOf(char code)
```
    Helper function to return the EventStatus represented by code. If code is not a valid EventStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The EventStatus 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<EventStatus>
    
    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<EventStatus,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<EventStatus>
    
    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<EventStatus,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<EventStatus,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<EventStatus,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<EventStatus>
    
    Returns:
    
    the database code for the enumeration

Enum EventStatus

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

Pending

PendingRaised

Raised

Cleared

Field Detail

PendingCode

PendingRaisedCode

RaisedCode

ClearedCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString