Package org.imixs.workflow.engine.plugins

Klasse HistoryPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.HistoryPlugin

Alle implementierten Schnittstellen:

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

Autor:

Ralph Soika

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	ITEM_HISTORY_LOG

Von Klasse geerbte Felder org.imixs.workflow.engine.plugins.AbstractPlugin

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HistoryPlugin()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
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.

Von Klasse geerbte Methoden org.imixs.workflow.engine.plugins.AbstractPlugin

close, getWorkflowContext, getWorkflowService, init, mergeFieldList, setWorkflowService, uniqueList

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

ITEM_HISTORY_LOG

public static final String ITEM_HISTORY_LOG

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

HistoryPlugin

public HistoryPlugin()

Methodendetails

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

Parameter:

adocumentContext - the workitem to be processed

adocumentActivity - the workflow event containing the processing instructions

Gibt zurück:

updated workitem for further processing

Löst aus:

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)