java.lang.Object
- java.lang.Enum<EWorkflowTriggerType>
- - de.xima.fc.mdl.enums.EWorkflowTriggerType

All Implemented Interfaces:

IWorkflowElementTypeProviding, IWorkflowTriggerTypeProviding, Serializable, Comparable<EWorkflowTriggerType>
```
public enum EWorkflowTriggerType
extends Enum<EWorkflowTriggerType>
implements IWorkflowTriggerTypeProviding
```
A list of built-in event names, as required by AWorkflowElement.getType()

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants
Enum Constant	Description
`FC_CATCH_ERROR`	This trigger fires when an unhandled error occurred during workflow execution of a task.
`FC_DOI_VERIFIED`	This trigger fires when an initialized Double-Opt-In is confirmed, i.e. via the form verify link.
`FC_FORM_SUBMIT_BUTTON`	This trigger fires when a form was submitted via a submit button (no qualifier).
`FC_INVITATION_ERROR`	This trigger fires when an invitation to a form record could not be sent correctly.
`FC_INVITATION_SENT`	This trigger fires when an invitation to a form record has been sent.
`FC_MANUAL`	This trigger fires only when it is triggered manually, such as by the user in the inbox, or via a trigger action.
`FC_QUALIFIED_FORM_SUBMIT_BUTTON`	This trigger fires when a form was submitted via a submit button (must match qualifier).
`FC_STATE_TIMER`	This trigger fires when a form record remains in a certain `WorkflowState` for a certain amount of time.
`FC_TIME_POINT`	This trigger fires at a certain point in time that is dependent upon the form data and allows for placeholders.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EWorkflowTriggerType`	`forEventName(String eventName)`
`static EWorkflowTriggerType`	`forKindOrNull(String eventName)`
`IGuiIcon`	`getDefaultIcon()`
`String`	`getOfficialHelpPagePath()`
`String`	`getType()`
`static EWorkflowTriggerType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EWorkflowTriggerType[]`	`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
  - FC_CATCH_ERROR
```
public static final EWorkflowTriggerType FC_CATCH_ERROR
```
    This trigger fires when an unhandled error occurred during workflow execution of a task. All other scheduled tasks are cleared and the tasks with an error trigger are run. In case any of those tasks throws an exception, no further tasks are triggered and execution is halted.
  - FC_DOI_VERIFIED
```
public static final EWorkflowTriggerType FC_DOI_VERIFIED
```
    This trigger fires when an initialized Double-Opt-In is confirmed, i.e. via the form verify link.
  - FC_FORM_SUBMIT_BUTTON
```
public static final EWorkflowTriggerType FC_FORM_SUBMIT_BUTTON
```
    This trigger fires when a form was submitted via a submit button (no qualifier).
  - FC_INVITATION_ERROR
```
public static final EWorkflowTriggerType FC_INVITATION_ERROR
```
    This trigger fires when an invitation to a form record could not be sent correctly.
  - FC_INVITATION_SENT
```
public static final EWorkflowTriggerType FC_INVITATION_SENT
```
    This trigger fires when an invitation to a form record has been sent.
  - FC_MANUAL
```
public static final EWorkflowTriggerType FC_MANUAL
```
    This trigger fires only when it is triggered manually, such as by the user in the inbox, or via a trigger action.
  - FC_QUALIFIED_FORM_SUBMIT_BUTTON
```
public static final EWorkflowTriggerType FC_QUALIFIED_FORM_SUBMIT_BUTTON
```
    This trigger fires when a form was submitted via a submit button (must match qualifier).
  - FC_STATE_TIMER
```
public static final EWorkflowTriggerType FC_STATE_TIMER
```
    This trigger fires when a form record remains in a certain WorkflowState for a certain amount of time.
  - FC_TIME_POINT
```
public static final EWorkflowTriggerType FC_TIME_POINT
```
    This trigger fires at a certain point in time that is dependent upon the form data and allows for placeholders.
- Method Detail
  - values
```
public static EWorkflowTriggerType[] 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 (EWorkflowTriggerType c : EWorkflowTriggerType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EWorkflowTriggerType 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
  - getDefaultIcon
```
public IGuiIcon getDefaultIcon()
```
    Returns:
    
    The default icon for this built-in trigger type.
  - getOfficialHelpPagePath
```
public String getOfficialHelpPagePath()
```
    Returns:
    
    The relative path to the help page in the official FORMCYCLE help.
  - getType
```
public String getType()
```
    Specified by:
    
    getType in interface IWorkflowElementTypeProviding
    
    Returns:
    
    The type of this built-in event. The type is a unique identifier that is used, for example, to determine, whether a trigger reacts to a certain event.
  - forEventName
```
public static EWorkflowTriggerType forEventName(String eventName)
```
    Parameters:
    
    eventName - The string representation of the event name.
    
    Returns:
    
    The enum type for the given event name.
    
    Throws:
    
    IllegalArgumentException - If the no enum type exists for the given event name string.
    
    NullPointerException - if the given event name is null.
  - forKindOrNull
```
public static EWorkflowTriggerType forKindOrNull(String eventName)
```
    Parameters:
    
    eventName - The string representation of the event name.
    
    Returns:
    
    The enum type for the given event name, or null when no such enum type exists.

Enum EWorkflowTriggerType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FC_CATCH_ERROR

FC_DOI_VERIFIED

FC_FORM_SUBMIT_BUTTON

FC_INVITATION_ERROR

FC_INVITATION_SENT

FC_MANUAL

FC_QUALIFIED_FORM_SUBMIT_BUTTON

FC_STATE_TIMER

FC_TIME_POINT

Method Detail

values

valueOf

getDefaultIcon

getOfficialHelpPagePath

getType

forEventName

forKindOrNull