Package de.xima.fc.mdl.enums

Enum EWorkflowStateType

java.lang.Object

java.lang.Enum<EWorkflowStateType>

de.xima.fc.mdl.enums.EWorkflowStateType

All Implemented Interfaces:

INamedUiElement, Serializable, Comparable<EWorkflowStateType>

public enum EWorkflowStateType
extends Enum<EWorkflowStateType>
implements INamedUiElement

Enumeration of WorkflowStates types that may be treated specially by the system.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants

Enum Constant	Description
CUSTOM	Custom state that was created by a backend user.
RECEIVED	The default state when a form was newly submitted and no other state was set by the workflow.

Field Summary

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method	Description
String	getDisplayDescription(Locale locale)
String	getDisplayName(Locale locale)	The display name of this element in the given locale.
IGuiIcon	getIcon()
static EWorkflowStateType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static EWorkflowStateType[]	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

Enum Constant Detail

CUSTOM

public static final EWorkflowStateType CUSTOM

Custom state that was created by a backend user. Custom states may be set by the workflow configuration.

RECEIVED

public static final EWorkflowStateType RECEIVED

The default state when a form was newly submitted and no other state was set by the workflow.

Method Detail

values

public static EWorkflowStateType[] 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 (EWorkflowStateType c : EWorkflowStateType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static EWorkflowStateType 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

getDisplayDescription

public String getDisplayDescription(Locale locale)

Parameters:

locale - Locale for which to localize the description.

Returns:

The localized description for this workflow state.

getDisplayName

public String getDisplayName(Locale locale)

Description copied from interface: INamedUiElement

The display name of this element in the given locale.

Specified by:

getDisplayName in interface INamedUiElement

Parameters:

locale - The locale to get the display name for.

Returns:

The display name of this element in the given locale.

getIcon

public IGuiIcon getIcon()

Returns:

The icon for this workflow state.