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

All Implemented Interfaces:

IWorkflowElementTypeProviding, IWorkflowNodeTypeProviding, Serializable, Comparable<EWorkflowNodeType>
```
public enum EWorkflowNodeType
extends Enum<EWorkflowNodeType>
implements IWorkflowNodeTypeProviding
```
A list of built-in workflow types. Each type can be though of as a statement in a program. Plugins can provide additional types.

Author:

XIMA MEDIA GmbH

Enum Constant Summary

Enum Constants
Enum Constant	Description
`FC_CHANGE_FORM_AVAILABILITY`	An action that changes a form to online or offline mode.
`FC_CHANGE_FORM_VALUE`	An action that changes form element values.
`FC_CHANGE_STATE`	A terminal action that changes the state of the current `Vorgang` and returns.
`FC_COMPRESS_AS_ZIP`	An action that compresses input files and outputs a ZIP file upon execution.
`FC_COPY_FORM_RECORD`	An action that makes a copy of the current form record, and optionally moves it to another inbox of invokes a trigger.
`FC_COUNTER`	An action that modifies counter entities.
`FC_CREATE_TEXT_FILE`	An action that writes content into a file.
`FC_DELETE_FORM_RECORD`	An end node that delete the form record, and stops the execution of the task.
`FC_DOI_INIT`	Workflow action that initializes the Double-opt-In process
`FC_EMAIL`	An action that sends mails
`FC_EMPTY`	An empty statement that represents a no-op.
`FC_EXPERIMENT`	A try statement that executes its first child.
`FC_EXPORT_TO_PERSISTENCE`	An action that exports a form record to a persistence structure
`FC_EXPORT_TO_XML`	An action that exports form data to an XML file.
`FC_FILL_PDF`	An action that writes content into an PDF template.
`FC_FILL_WORD`	An action that writes content into an Word template.
`FC_IMPORT_FORM_VALUE_FROM_XML`	An action that import form values from XML.
`FC_LDAP_QUERY`	An action that executes an ldap query.
`FC_MOVE_FORM_RECORD_TO_INBOX`	An action that move a form record to an selected inbox
`FC_MULTIPLE_CONDITION`	An if statement that forks the control flow.
`FC_POST_REQUEST`	An action that sends an HTTP request upon execution.
`FC_PROVIDE_RESOURCE`	An action that provides a resource for workflow processing.
`FC_QUEUE_TASK`	A terminal action that add a task of a certain trigger to the queue and returns.
`FC_REDIRECT`	An action for redirect to a specific URL
`FC_RENEW_PROCESS_ID`	An action for renew the current process id
`FC_RETURN`	An end node that stops the execution of the task.
`FC_RETURN_FILE`	An action that returns files as an download in the browser
`FC_SAVE_TO_FILE_SYSTEM`	An action that saves files on the file system
`FC_SET_SAVED_FLAG`	An action that marks form records as saved
`FC_SHOW_TEMPLATE`	An action that shows an template as an response result
`FC_SQL_STATEMENT`	An action that executes an sql statement.
`FC_THROW_EXCEPTION`	An end node that throws an exception.
`FC_WRITE_FORM_RECORD_ATTRIBUTES`	An action that writes key value parameter to the current form record
`SEQUENCE`	A sequence (block) statement that executes each of its children in order.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static EWorkflowNodeType`	`forKind(String kind)`
`static EWorkflowNodeType`	`forKindOrNull(String kind)`
`IGuiIcon`	`getDefaultIcon()`
`String`	`getOfficialHelpPagePath()`
`String`	`getType()`
`static EWorkflowNodeType`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static EWorkflowNodeType[]`	`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_CHANGE_FORM_AVAILABILITY
```
public static final EWorkflowNodeType FC_CHANGE_FORM_AVAILABILITY
```
    An action that changes a form to online or offline mode.
  - FC_CHANGE_FORM_VALUE
```
public static final EWorkflowNodeType FC_CHANGE_FORM_VALUE
```
    An action that changes form element values.
  - FC_CHANGE_STATE
```
public static final EWorkflowNodeType FC_CHANGE_STATE
```
    A terminal action that changes the state of the current Vorgang and returns.
  - FC_COMPRESS_AS_ZIP
```
public static final EWorkflowNodeType FC_COMPRESS_AS_ZIP
```
    An action that compresses input files and outputs a ZIP file upon execution.
  - FC_COPY_FORM_RECORD
```
public static final EWorkflowNodeType FC_COPY_FORM_RECORD
```
    An action that makes a copy of the current form record, and optionally moves it to another inbox of invokes a trigger.
  - FC_COUNTER
```
public static final EWorkflowNodeType FC_COUNTER
```
    An action that modifies counter entities.
  - FC_CREATE_TEXT_FILE
```
public static final EWorkflowNodeType FC_CREATE_TEXT_FILE
```
    An action that writes content into a file.
  - FC_DELETE_FORM_RECORD
```
public static final EWorkflowNodeType FC_DELETE_FORM_RECORD
```
    An end node that delete the form record, and stops the execution of the task.
    A node of this kind must not have any children.
  - FC_DOI_INIT
```
public static final EWorkflowNodeType FC_DOI_INIT
```
    Workflow action that initializes the Double-opt-In process
  - FC_EMAIL
```
public static final EWorkflowNodeType FC_EMAIL
```
    An action that sends mails
  - FC_EMPTY
```
public static final EWorkflowNodeType FC_EMPTY
```
    An empty statement that represents a no-op.
    A node of this kind must not have any children.
  - FC_EXPERIMENT
```
public static final EWorkflowNodeType FC_EXPERIMENT
```
    A try statement that executes its first child. When any error or exception occurs during the execution of that child (the body statement), it catches that error or exception, and executes its second child (the catch statement). Otherwise, when no error exception occurred during the execution of the body statement, the catch statement is not executed.
    Any error or exception that occurs during the execution of the catch statement is propagated upwards.
    In case a third child (the finally statement) exists, it is always executed after the body and catch statement are done. This is true even if an error or exception occurred during the catch statement. However, that error must be propagated upwards after the finally statement finishes.
  - FC_EXPORT_TO_PERSISTENCE
```
public static final EWorkflowNodeType FC_EXPORT_TO_PERSISTENCE
```
    An action that exports a form record to a persistence structure
  - FC_EXPORT_TO_XML
```
public static final EWorkflowNodeType FC_EXPORT_TO_XML
```
    An action that exports form data to an XML file.
  - FC_FILL_PDF
```
public static final EWorkflowNodeType FC_FILL_PDF
```
    An action that writes content into an PDF template.
  - FC_FILL_WORD
```
public static final EWorkflowNodeType FC_FILL_WORD
```
    An action that writes content into an Word template.
  - FC_IMPORT_FORM_VALUE_FROM_XML
```
public static final EWorkflowNodeType FC_IMPORT_FORM_VALUE_FROM_XML
```
    An action that import form values from XML.
  - FC_LDAP_QUERY
```
public static final EWorkflowNodeType FC_LDAP_QUERY
```
    An action that executes an ldap query.
  - FC_MOVE_FORM_RECORD_TO_INBOX
```
public static final EWorkflowNodeType FC_MOVE_FORM_RECORD_TO_INBOX
```
    An action that move a form record to an selected inbox
  - FC_MULTIPLE_CONDITION
```
public static final EWorkflowNodeType FC_MULTIPLE_CONDITION
```
    An if statement that forks the control flow. Allows for multiple conditions to be specified.
    A node of this kind must have at most two children, and should have at least one child. The first child is the consequent, the second child the alternate.
    During execution, the if statement runs a test and executes its first child (the consequent) when the test passes, or its second child (the alternate) otherwise.
    The consequent or the alternate may be null, in which case execution must behave as if it were an FC_EMPTY statement.
    Any error or exception that occurs must stop the execution immediately and propagate the error upwards.
  - FC_POST_REQUEST
```
public static final EWorkflowNodeType FC_POST_REQUEST
```
    An action that sends an HTTP request upon execution. This action previously only supported POST requests, but now supports arbitrary HTTP verbs. Note that this enum constant should be named FC_HTTP_REQUEST, but needs to retain its old name for backwards compatibility.
  - FC_PROVIDE_RESOURCE
```
public static final EWorkflowNodeType FC_PROVIDE_RESOURCE
```
    An action that provides a resource for workflow processing.
  - FC_QUEUE_TASK
```
public static final EWorkflowNodeType FC_QUEUE_TASK
```
    A terminal action that add a task of a certain trigger to the queue and returns.
  - FC_REDIRECT
```
public static final EWorkflowNodeType FC_REDIRECT
```
    An action for redirect to a specific URL
  - FC_RENEW_PROCESS_ID
```
public static final EWorkflowNodeType FC_RENEW_PROCESS_ID
```
    An action for renew the current process id
  - FC_RETURN
```
public static final EWorkflowNodeType FC_RETURN
```
    An end node that stops the execution of the task.
    A node of this kind must not have any children.
  - FC_RETURN_FILE
```
public static final EWorkflowNodeType FC_RETURN_FILE
```
    An action that returns files as an download in the browser
  - FC_SAVE_TO_FILE_SYSTEM
```
public static final EWorkflowNodeType FC_SAVE_TO_FILE_SYSTEM
```
    An action that saves files on the file system
  - FC_SET_SAVED_FLAG
```
public static final EWorkflowNodeType FC_SET_SAVED_FLAG
```
    An action that marks form records as saved
  - FC_SHOW_TEMPLATE
```
public static final EWorkflowNodeType FC_SHOW_TEMPLATE
```
    An action that shows an template as an response result
  - FC_SQL_STATEMENT
```
public static final EWorkflowNodeType FC_SQL_STATEMENT
```
    An action that executes an sql statement.
  - FC_THROW_EXCEPTION
```
public static final EWorkflowNodeType FC_THROW_EXCEPTION
```
    An end node that throws an exception. Can be used to rethrow an exception etc.
    A node of this kind must not have any children.
  - FC_WRITE_FORM_RECORD_ATTRIBUTES
```
public static final EWorkflowNodeType FC_WRITE_FORM_RECORD_ATTRIBUTES
```
    An action that writes key value parameter to the current form record
  - SEQUENCE
```
public static final EWorkflowNodeType SEQUENCE
```
    A sequence (block) statement that executes each of its children in order.
    A node of this kind may have any number of children, including no children at all.
    Any error or exception that occurs must stop the execution immediately (no more children are executed), and propagate the error upwards.
- Method Detail
  - values
```
public static EWorkflowNodeType[] 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 (EWorkflowNodeType c : EWorkflowNodeType.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EWorkflowNodeType 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 workflow node.
  - 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:
    
    A string the identifies this node kind. This correspond to AWorkflowElement.getType().
  - forKind
```
public static EWorkflowNodeType forKind(String kind)
```
    Parameters:
    
    kind - The string representation of the node kind.
    
    Returns:
    
    The enum type for the given node kind.
    
    Throws:
    
    IllegalArgumentException - If the no enum type exists for the given kind string.
    
    NullPointerException - if the given kind is null.
  - forKindOrNull
```
public static EWorkflowNodeType forKindOrNull(String kind)
```
    Parameters:
    
    kind - The string representation of the node kind.
    
    Returns:
    
    The enum type for the given node kind, or null when no such enum type exists.

Enum EWorkflowNodeType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

FC_CHANGE_FORM_AVAILABILITY

FC_CHANGE_FORM_VALUE

FC_CHANGE_STATE

FC_COMPRESS_AS_ZIP

FC_COPY_FORM_RECORD

FC_COUNTER

FC_CREATE_TEXT_FILE

FC_DELETE_FORM_RECORD

FC_DOI_INIT

FC_EMAIL

FC_EMPTY

FC_EXPERIMENT

FC_EXPORT_TO_PERSISTENCE

FC_EXPORT_TO_XML

FC_FILL_PDF

FC_FILL_WORD

FC_IMPORT_FORM_VALUE_FROM_XML

FC_LDAP_QUERY

FC_MOVE_FORM_RECORD_TO_INBOX

FC_MULTIPLE_CONDITION

FC_POST_REQUEST

FC_PROVIDE_RESOURCE

FC_QUEUE_TASK

FC_REDIRECT

FC_RENEW_PROCESS_ID

FC_RETURN

FC_RETURN_FILE

FC_SAVE_TO_FILE_SYSTEM

FC_SET_SAVED_FLAG

FC_SHOW_TEMPLATE

FC_SQL_STATEMENT

FC_THROW_EXCEPTION

FC_WRITE_FORM_RECORD_ATTRIBUTES

SEQUENCE

Method Detail

values

valueOf

getDefaultIcon

getOfficialHelpPagePath

getType

forKind

forKindOrNull