org.imixs.workflow.engine.plugins

Class ResultPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.ResultPlugin

All Implemented Interfaces:

Plugin

public class ResultPlugin
extends AbstractPlugin

This Plug-In evaluates the result message provided by the Activity property 'txtActivityResult'. The value will be parsed for the xml tag 'item' value The provided value will be assigned to the named property. The value can also be evaluated with the tag 'itemValue' namCreator

Version:

1.0

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_FORMAT

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

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor and Description
ResultPlugin()

Method Summary

Modifier and Type	Method and Description
static ItemCollection	evaluateWorkflowResult(ItemCollection activityEntity, ItemCollection documentContext) The method evaluates the WorkflowResult and resolves embedded ItemValues
static ItemCollection	evaluateWorkflowResult(ItemCollection activityEntity, ItemCollection documentContext, boolean resolveItemValues) The method evaluates the WorkflowResult for a given activityEntity and returns a ItemColleciton containing all item definitions.
static ItemCollection	parseItemStructure(String xmlContent) This method parses the xml content of a item element and returns a new ItemCollection containing all item values.
ItemCollection	run(ItemCollection documentContext, ItemCollection adocumentActivity)

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

close, formatItemValues, formatItemValues, getCtx, getWorkflowService, init, mergeFieldList, mergeValueList, replaceDynamicValues, uniqueList

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_FORMAT

public static final String INVALID_FORMAT

See Also:

Constant Field Values

Constructor Detail

ResultPlugin

public ResultPlugin()

Method Detail

run

public ItemCollection run(ItemCollection documentContext,
                          ItemCollection adocumentActivity)
                   throws PluginException

Throws:

PluginException

parseItemStructure

public static ItemCollection parseItemStructure(String xmlContent)
                                         throws PluginException

This method parses the xml content of a item element and returns a new ItemCollection containing all item values. Each tag is evaluated as the item name. MultiValues are currently not supported. Example: 1.0.0 1000 10 namTeam

Parameters:

evalItemCollection -

Throws:

PluginException

evaluateWorkflowResult

public static ItemCollection evaluateWorkflowResult(ItemCollection activityEntity,
                                                    ItemCollection documentContext,
                                                    boolean resolveItemValues)
                                             throws PluginException

The method evaluates the WorkflowResult for a given activityEntity and returns a ItemColleciton containing all item definitions. Each item definition of a WorkflowResult contains a name and a optional list of additional attributes. The method generates a item for each content element and attribute value.
e.g. text
will result in the attributes 'comment' with value 'text' and 'comment.ignore' with the value 'true' Also embedded itemVaues can be resolved (resolveItemValues=true): ABC$uniqueid This example will result in a new item 'somedata' with the $unqiueid prafixed with 'ABC'

Parameters:

activityEntity -

documentContext -

resolveItemValues - - if true, itemValue tags will be resolved.

Returns:

Throws:

PluginException

See Also:

parsing-using-regex-in-java.html

evaluateWorkflowResult

public static ItemCollection evaluateWorkflowResult(ItemCollection activityEntity,
                                                    ItemCollection documentContext)
                                             throws PluginException

The method evaluates the WorkflowResult and resolves embedded ItemValues. * ABC$uniqueid This example will result in a new item 'somedata' with the $unqiueid prafixed with 'ABC'

Parameters:

activityEntity -

documentContext -

Returns:

Throws:

PluginException

See Also:

evaluateWorkflowResult(ItemCollection activityEntity, ItemCollection documentContext,boolean resolveItemValues)