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

All Implemented Interfaces:

BaseSchedulerEnumeration<UserMessageFlowAction,Character>, SchedulerEnumeration<UserMessageFlowAction>, Serializable, Comparable<UserMessageFlowAction>
```
public enum UserMessageFlowAction
extends Enum<UserMessageFlowAction>
implements SchedulerEnumeration<UserMessageFlowAction>
```
The flow control action of the UserMessage (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`AddedAttachment`	An attachment has been added to the UserMessage
`Completed`	UserMessage has been completed
`Created`	UserMessage has been created
`Delegated`	UserMessage has been delegated to another party
`DeletedAttachment`	An attachment has been deleted from the UserMessage
`Forwarded`	UserMessage has been forwarded for comment to another party
`ProxyApplied`	UserMessage was redirected because of out of office
`ReplacedAttachment`	An attachment has been replaced on the UserMessage
`Respond`	UserMessage has been returned to the responsible party
`Updated`	The UserMessage comment has been updated
`UploadedAttachment`	An attachment has been added to the UserMessage

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`AddedAttachmentCode`	The char returned from AddedAttachment.getCodeEx().
`static char`	`CompletedCode`	The char returned from Completed.getCodeEx().
`static char`	`CreatedCode`	The char returned from Created.getCodeEx().
`static char`	`DelegatedCode`	The char returned from Delegated.getCodeEx().
`static char`	`DeletedAttachmentCode`	The char returned from DeletedAttachment.getCodeEx().
`static char`	`ForwardedCode`	The char returned from Forwarded.getCodeEx().
`static char`	`ProxyAppliedCode`	The char returned from ProxyApplied.getCodeEx().
`static char`	`ReplacedAttachmentCode`	The char returned from ReplacedAttachment.getCodeEx().
`static char`	`RespondCode`	The char returned from Respond.getCodeEx().
`static char`	`UpdatedCode`	The char returned from Updated.getCodeEx().
`static char`	`UploadedAttachmentCode`	The char returned from UploadedAttachment.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 UserMessageFlowAction`	`safeValueOf(String value)`	Helper function to return the UserMessageFlowAction represented by `value`.
`static UserMessageFlowAction`	`valueOf(char code)`	Helper function to return the UserMessageFlowAction represented by code.
`static UserMessageFlowAction`	`valueOf(Character code)`	Helper function to return the UserMessageFlowAction represented by code.
`static UserMessageFlowAction`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static UserMessageFlowAction`	`valueOfCode(String code)`	Helper function to return the UserMessageFlowAction represented by code.
`static UserMessageFlowAction[]`	`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
  - Created
```
public static final UserMessageFlowAction Created
```
    UserMessage has been created
  - Delegated
```
public static final UserMessageFlowAction Delegated
```
    UserMessage has been delegated to another party
  - Forwarded
```
public static final UserMessageFlowAction Forwarded
```
    UserMessage has been forwarded for comment to another party
  - Respond
```
public static final UserMessageFlowAction Respond
```
    UserMessage has been returned to the responsible party
  - Completed
```
public static final UserMessageFlowAction Completed
```
    UserMessage has been completed
  - AddedAttachment
```
public static final UserMessageFlowAction AddedAttachment
```
    An attachment has been added to the UserMessage
  - ReplacedAttachment
```
public static final UserMessageFlowAction ReplacedAttachment
```
    An attachment has been replaced on the UserMessage
  - UploadedAttachment
```
public static final UserMessageFlowAction UploadedAttachment
```
    An attachment has been added to the UserMessage
  - DeletedAttachment
```
public static final UserMessageFlowAction DeletedAttachment
```
    An attachment has been deleted from the UserMessage
  - Updated
```
public static final UserMessageFlowAction Updated
```
    The UserMessage comment has been updated
  - ProxyApplied
```
public static final UserMessageFlowAction ProxyApplied
```
    UserMessage was redirected because of out of office
- Field Detail
  - CreatedCode
```
public static final char CreatedCode
```
    The char returned from Created.getCodeEx().
    
    See Also:
    
    Created, 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
  - RespondCode
```
public static final char RespondCode
```
    The char returned from Respond.getCodeEx().
    
    See Also:
    
    Respond, Constant Field Values
  - CompletedCode
```
public static final char CompletedCode
```
    The char returned from Completed.getCodeEx().
    
    See Also:
    
    Completed, Constant Field Values
  - AddedAttachmentCode
```
public static final char AddedAttachmentCode
```
    The char returned from AddedAttachment.getCodeEx().
    
    See Also:
    
    AddedAttachment, Constant Field Values
  - ReplacedAttachmentCode
```
public static final char ReplacedAttachmentCode
```
    The char returned from ReplacedAttachment.getCodeEx().
    
    See Also:
    
    ReplacedAttachment, Constant Field Values
  - UploadedAttachmentCode
```
public static final char UploadedAttachmentCode
```
    The char returned from UploadedAttachment.getCodeEx().
    
    See Also:
    
    UploadedAttachment, Constant Field Values
  - DeletedAttachmentCode
```
public static final char DeletedAttachmentCode
```
    The char returned from DeletedAttachment.getCodeEx().
    
    See Also:
    
    DeletedAttachment, Constant Field Values
  - UpdatedCode
```
public static final char UpdatedCode
```
    The char returned from Updated.getCodeEx().
    
    See Also:
    
    Updated, Constant Field Values
  - ProxyAppliedCode
```
public static final char ProxyAppliedCode
```
    The char returned from ProxyApplied.getCodeEx().
    
    See Also:
    
    ProxyApplied, Constant Field Values
- Method Detail
  - values
```
public static UserMessageFlowAction[] 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 (UserMessageFlowAction c : UserMessageFlowAction.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UserMessageFlowAction 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 UserMessageFlowAction valueOfCode(String code)
```
    Helper function to return the UserMessageFlowAction 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 UserMessageFlowAction
    
    Returns:
    
    The UserMessageFlowAction corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static UserMessageFlowAction safeValueOf(String value)
```
    Helper function to return the UserMessageFlowAction represented by value. If value is null, or not a valid UserMessageFlowAction 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 UserMessageFlowAction corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static UserMessageFlowAction valueOf(Character code)
```
    Helper function to return the UserMessageFlowAction represented by code. If code is null, or not a valid UserMessageFlowAction code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The UserMessageFlowAction corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static UserMessageFlowAction valueOf(char code)
```
    Helper function to return the UserMessageFlowAction represented by code. If code is not a valid UserMessageFlowAction code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The UserMessageFlowAction 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<UserMessageFlowAction>
    
    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<UserMessageFlowAction,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<UserMessageFlowAction>
    
    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<UserMessageFlowAction,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<UserMessageFlowAction,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<UserMessageFlowAction,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<UserMessageFlowAction>
    
    Returns:
    
    the database code for the enumeration

Enum UserMessageFlowAction

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

Created

Delegated

Forwarded

Respond

Completed

AddedAttachment

ReplacedAttachment

UploadedAttachment

DeletedAttachment

Updated

ProxyApplied

Field Detail

CreatedCode

DelegatedCode

ForwardedCode

RespondCode

CompletedCode

AddedAttachmentCode

ReplacedAttachmentCode

UploadedAttachmentCode

DeletedAttachmentCode

UpdatedCode

ProxyAppliedCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString