org.imixs.workflow
Interface Plugin

public interface Plugin

A Plugin defines the interface between the WorkflowKernel and the underlying softwaresystem in which the plugin runns. Every Plugin have to be registerd to the workflowkernel by the workflowmanager. In this way the WorkflowManager can control the functionallity of a single workflowactivity by defining the used plugin-moduls.

Version:

1.0

Author:

Ralph Soika

See Also:

WorkflowKernel

Field Summary

static int	PLUGIN_ERROR
static int	PLUGIN_OK
static int	PLUGIN_WARNING

Method Summary

void	close(int status) This CallBack method is used to give the plugin the chance to close plugin specific data
void	init(WorkflowContext actx) The init Methode is usesd to initialize the plugin.
int	run(ItemCollection documentContext, ItemCollection documentActivity)

Field Detail

PLUGIN_ERROR

static final int PLUGIN_ERROR

See Also:

Constant Field Values

PLUGIN_WARNING

static final int PLUGIN_WARNING

See Also:

Constant Field Values

PLUGIN_OK

static final int PLUGIN_OK

See Also:

Constant Field Values

Method Detail

init

void init(WorkflowContext actx)
          throws PluginException

The init Methode is usesd to initialize the plugin.

Parameters:

actx - defines the context in which the plugin runs a Plugin can use this context to get information about the enviroment

Throws:

PluginException

run

int run(ItemCollection documentContext,
        ItemCollection documentActivity)
        throws PluginException

Parameters:

documentContext - defines the document to be processed

documentActivity - defines the activity document which contains the workflowprocessing instructions

Returns:

the current status for this plugin

Throws:

PluginException

close

void close(int status)
           throws PluginException

This CallBack method is used to give the plugin the chance to close plugin specific data

Parameters:

status - gives the plugin information about the current status. this parameter is delivered by the workflowKernel.

Throws:

PluginException