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

Interface IPluginWorkflowTrigger

All Superinterfaces:

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

All Known Subinterfaces:

IPluginTriggerHandler<TData>

All Known Implementing Classes:

APluginTriggerHandler

public interface IPluginWorkflowTrigger
extends IFCPlugin, IPluginGenericCustomGUI<IPluginWorkflowTriggerBean>

Interface for workflow trigger plugins. This plugin lets you add a custom workflow trigger to the workflow designer.

Each workflow task has got exactly one trigger. The trigger handler is responsible for reacting to events when they are triggered by the system. For each event the handler must decide whether the trigger applies to that event. If it does, the task is executed. Please note that to trigger an event, you may need to implement additional plugins. For example, you could create a servlet action plugin that triggers a custom event when an HTTP request is made; and a trigger plugin that reacts to that custom event.

On the server side, the main methods to implement are getFilterCriteriaForEvent, isAppliesTo, and isPreconditionSatisfied. On the client side, the main method to implement is getJavaScript, which needs to return a JavaScript file that calls Flowchart.registerTrigger(nodeType: string, triggerHandler: Object) to register the client side node handler.

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

Modifier and Type	Method	Description
ITriggerHandler<?>	getTriggerHandler()
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, validateConfigurationData

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

getUnmanagedBeans

Method Detail

getTriggerHandler

ITriggerHandler<?> getTriggerHandler()

Returns:

The trigger handler that implements all the logic required by the workflow trigger. This lets you customize all features available to built-in workflow triggers.

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 classpath resources of the plugin. In this case, simply return an URL to resource (jar:file:/...) like so:

 @Override
 public URL getXhtmlView() {
   return getClass().getResource("/path/to/view.xhtml");
 }
 

Specified by:

getXhtmlView in interface IPluginGenericCustomGUI<IPluginWorkflowTriggerBean>

Returns:

Path to the Facelet view. Must not return null. May return null to indicate that no custom view is available. Whether a custom view is required depends on the type of the plugin.