Package org.imixs.workflow.engine.plugins

Class HistoryPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.HistoryPlugin

All Implemented Interfaces:

Plugin

public class HistoryPlugin
extends AbstractPlugin

This Plugin creates a history log in the property txtWorkflowHistory. The history log contains a list of history entires. Each entry provides the following information:

• date of creation (Date)
• comment (String)
• userID (String)

Note: In early versions of this plugin the history entries were stored in a simple string list. The date was separated by the char sequence ' : ' from the comment entry. The userId was not stored explicit. This plugin converts the old format automatically (see method convertOldFormat)

Version:

2.0

Author:

Ralph Soika

Field Summary

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

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor	Description
HistoryPlugin()

Method Summary

Modifier and Type	Method	Description
protected void	convertOldFormat()	This method converts the old StringList format in the new format with a list of separated values: date of creation (Date) comment (String) userID (String)
ItemCollection	run(ItemCollection adocumentContext, ItemCollection adocumentActivity)	Update the Log entry.

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

close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryPlugin

public HistoryPlugin()

Method Detail

run

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

Update the Log entry. The method tests if the deprecated property 'txtworkflowhistorylogrev' exists. In this case the old log format will be transformed into the new format see method convertOldFormat

Parameters:

adocumentContext - the workitem to be processed

adocumentActivity - the workflow event containing the processing instructions

Returns:

updated workitem for further processing

Throws:

PluginException

convertOldFormat

protected void convertOldFormat()

This method converts the old StringList format in the new format with a list of separated values:

• date of creation (Date)
• comment (String)
• userID (String)