org.imixs.workflow.plugins
Class ResultPlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin
      org.imixs.workflow.plugins.ResultPlugin

All Implemented Interfaces:

Plugin

public class ResultPlugin
extends AbstractPlugin

This Pluginmodul generates a result message. The Plugin checks if the activiy document has an "txtActivityResult" attribute. The value will be parsed for "attribute" tags and these tags will be replaced with the values of the corresponding attributes of the workitem. The final result will be stored into the attribute "txtworkflowresultmessage". This field could be used by an application to display individual messages (e.g HTML Code) or return result Strings (e.g. JSF Action Results)

Version:

1.0

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

Fields inherited from class org.imixs.workflow.plugins.AbstractPlugin

ctx

Fields inherited from interface org.imixs.workflow.Plugin

PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

Constructor Summary

ResultPlugin()

Method Summary

void	close(int status) This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data
int	run(ItemCollection adocumentContext, ItemCollection adocumentActivity)

Methods inherited from class org.imixs.workflow.plugins.AbstractPlugin

formatItemValues, getAbbreviateName, getCommonName, init, replaceDynamicValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResultPlugin

public ResultPlugin()

Method Detail

run

public int run(ItemCollection adocumentContext,
               ItemCollection adocumentActivity)
        throws Exception

Parameters:

adocumentContext - defines the document to be processed

adocumentActivity - defines the activity document which contains the workflowprocessing instructions

Returns:

the current status for this plugin

Throws:

Exception

close

public void close(int status)

Description copied from interface: Plugin

This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data

Parameters:

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