IPluginWorkflowNode (FORMCYCLE: BOM 7.0.1 API)

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, IPluginGenericCustomGUI<IPluginWorkflowNodeBean>, ITransferable, Serializable

All Known Subinterfaces:

IPluginActionNodeHandler<TData>

All Known Implementing Classes:

APluginActionNodeHandler
```
public interface IPluginWorkflowNode
extends IFCPlugin, IPluginGenericCustomGUI<IPluginWorkflowNodeBean>
```
Interface for workflow node plugins. This plugin lets you add a custom workflow action or control node to the workflow designer. This is a low-level interface that allows for fine-tuned control of all aspects of a workflow node, and can be used, for example, to implement a custom try-catch block or loop flow control node.
In case you only wish to add an action that executes some business logic, consider using de.xima.fc.workflow.mixin.IPluginActionNodeHandler, or de.xima.fc.workflow.mixin.APluginActionNodeHandler if you do not need a custom super class.
This plugin can be installed as both a system as well as a client plugin.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary
- Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
  CONFIG_FILENAME
- Fields inherited from interface de.xima.fc.interfaces.INamedUiElement
  ATTR_DISPLAY_NAME
- Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding
  ATTR_NAME, COL_NAME

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`INodeHandler<?>`	`getNodeHandler()`
`default URL`	`getXhtmlView()`	This method must return the path to the XHTML page for the custom user interface.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin
getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Methods inherited from interface de.xima.fc.plugin.config.IPluginGenericCustomGUI
getUnmanagedBeans

- Method Detail
  - getNodeHandler
```
INodeHandler<?> getNodeHandler()
```
    Returns:
    
    The node handler that implements all the logic required by the workflow node. This lets you customize all features available to built-in workflow nodes.
  - getXhtmlView
```
default URL getXhtmlView()
```
    Description copied from interface: IPluginGenericCustomGUI
    This method must return the path to the XHTML page for the custom user interface. Usually the XHTML file is part of the JAR resources of the plugin. In this case, you should return an URL to a JAR file resource (jar:file:/...) like so:
    @Override public URL getXhtmlView() { return getClass().getResource("/path/to/view.xhtml"); }
    Specified by:
    
    getXhtmlView in interface IPluginGenericCustomGUI<IPluginWorkflowNodeBean>
    
    Returns:
    
    Path to the XHTML view. Must not return null. If you do return null, it will be treated as an error.