Package de.xima.fc.plugin.interfaces.workflow

Interface IPluginWorkflowElementPrototypes

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginWorkflowElementPrototypes
extends IFCPlugin

Allows plugins to offer preconfigured workflow elements (triggers and nodes. Node plugins and trigger plugins also allow preconfigured elements to be specified, but require that you define a new node or trigger type.

Since:

8.0.1

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

Modifier and Type	Method	Description
Iterable<? extends INodePrototypeDescriptor<?>>	getNodePrototypes(IGetNodePrototypesParams params)	Returns a list of all node prototypes to be made available in the workflow designer.
Iterable<? extends ITriggerPrototypeDescriptor<?>>	getTriggerPrototypes(IGetTriggerPrototypesParams params)	Returns a list of all trigger prototypes to be made available in the workflow designer.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Method Detail

getNodePrototypes

Iterable<? extends INodePrototypeDescriptor<?>> getNodePrototypes(IGetNodePrototypesParams params)

Returns a list of all node prototypes to be made available in the workflow designer. Each prototype appears in the drawer panel of the workflow designer. The user can move a node prototype via drag & drop into the design area in the center to add the node to the current flowchart.

Parameters:

params - Parameters for this method, such as the current locale for localizing the display name of the prototypes.

Returns:

A list of all available prototypes. null is treated as an empty list.

Throws:

RuntimeException - This method should normally not throw an exception. A runtime exception may be thrown when the node prototypes cannot be created for an unknown reason. When an exception is thrown, no node prototypes are made available for this handler.

getTriggerPrototypes

Iterable<? extends ITriggerPrototypeDescriptor<?>> getTriggerPrototypes(IGetTriggerPrototypesParams params)

Returns a list of all trigger prototypes to be made available in the workflow designer. Each prototype appears in the drawer panel of the workflow designer. The user can move a trigger prototype via drag & drop into the design area in the center to add the trigger to the current flowchart.

Parameters:

params - Parameters for this method, such as the current locale for localizing the display name of the prototypes.

Returns:

A list of all available prototypes. null is treated as an empty list.

Throws:

RuntimeException - This method should normally not throw an exception. A runtime exception may be thrown when the node prototypes cannot be created for an unknown reason. When an exception is thrown, no node prototypes are made available for this handler.