ee.telekom.workflow.executor.plugin

Interface WorkflowEnginePlugin

All Known Implementing Classes:

WorkflowEnginePluginImpl

public interface WorkflowEnginePlugin

Provides plugin hooks for the workflow engine.

Author:

Christian Klock

Method Summary

Modifier and Type	Method and Description
Object	getBean(String name) Returns the bean with the given name as provided by the plugin.
GraphRepository	getGraphRepository() Returns the repository of graphs provided by the plugin.
boolean	isStarted() Returns whether the engine has successfully started.
void	onHumanTaskCancelled(GraphWorkItem workItem) Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was aborted.
void	onHumanTaskCancelled(WorkflowInstance workflowInstance, WorkItem workItem) Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was aborted.
void	onHumanTaskCompleted(GraphWorkItem workItem) Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was completed.
void	onHumanTaskCreated(GraphWorkItem workItem) Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was created.
void	onWorkflowInstanceAborted(GraphInstance instance) Notifies all WorkflowInstanceEventListener's provided by the plugin that a workflow instance was aborted.
void	onWorkflowInstanceCompleted(GraphInstance instance) Notifies all WorkflowInstanceEventListener's provided by the plugin that a workflow instance execution completed.
void	onWorkflowInstanceCreated(GraphInstance instance) Notifies all WorkflowInstanceEventListener's provided by the plugin that a graph instance was created.
void	reloadWorkflowDefinitions() Reloads all workflow definitions in the plugin's graph repository.
void	start() Lifecycle method that is called in order to give the plugin a chance for custom initialization.
void	stop() Lifecycle method that is called in order to give the plugin a chance for a clean shut-down.

Method Detail

start

void start()

Lifecycle method that is called in order to give the plugin a chance for custom initialization.

Is always called before any other method (except isStarted().

Will not throw an Exception if an error occurs. Use isStarted() after a call to this method in order to verify that the plug-in started successfully.

stop

void stop()

Lifecycle method that is called in order to give the plugin a chance for a clean shut-down.

It is guaranteed that none of the other methods (except start() for a restart or isStarted()) is called after the plugin is stopped.

isStarted

boolean isStarted()

Returns whether the engine has successfully started.

getGraphRepository

GraphRepository getGraphRepository()

Returns the repository of graphs provided by the plugin. Returns null, if the plugin is not started.

Returns:

getBean

Object getBean(String name)

Returns the bean with the given name as provided by the plugin.

reloadWorkflowDefinitions

void reloadWorkflowDefinitions()

Reloads all workflow definitions in the plugin's graph repository.

onWorkflowInstanceCreated

void onWorkflowInstanceCreated(GraphInstance instance)

Notifies all WorkflowInstanceEventListener's provided by the plugin that a graph instance was created.

onWorkflowInstanceCompleted

void onWorkflowInstanceCompleted(GraphInstance instance)

Notifies all WorkflowInstanceEventListener's provided by the plugin that a workflow instance execution completed.

onWorkflowInstanceAborted

void onWorkflowInstanceAborted(GraphInstance instance)

Notifies all WorkflowInstanceEventListener's provided by the plugin that a workflow instance was aborted.

onHumanTaskCreated

void onHumanTaskCreated(GraphWorkItem workItem)

Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was created.

onHumanTaskCompleted

void onHumanTaskCompleted(GraphWorkItem workItem)

Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was completed.

onHumanTaskCancelled

void onHumanTaskCancelled(GraphWorkItem workItem)

Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was aborted.

onHumanTaskCancelled

void onHumanTaskCancelled(WorkflowInstance workflowInstance,
                          WorkItem workItem)

Notifies all HumanTaskEventListener's provided by the plugin that a human task work item was aborted.

This method is called rather than onHumanTaskCancelled(GraphWorkItem), if the associates workflow instance's workflow definition is not provided by the plugin anymore.