Package org.imixs.workflow.engine.plugins

Class DocumentComposerPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.workflow.engine.plugins.DocumentComposerPlugin

All Implemented Interfaces:

Plugin

public class DocumentComposerPlugin
extends AbstractPlugin

This DocumentComposer Plugin creates html output stored in a item. The DocumentComposer is based on BPMN DataObjects assigned to the target task.

  
 
 
    	<item name="document-composer" data-object="template1">htmloutput</item>
 
 
 

Version:

2.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field	Description
static String	INVALID_DATA_OBJECT
static String	INVALID_XSL_FORMAT
static String	ITEM_DOCUMENT_COMPOSER

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

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor	Description
DocumentComposerPlugin()

Method Summary

Modifier and Type	Method	Description
void	init(WorkflowContext actx)	Initialize Plugin and get an instance of the EJB Session Context
ItemCollection	run(ItemCollection documentContext, ItemCollection event)	This method adds the attachments of the blob workitem to the MimeMessage
String	transformXSLTemplate(ItemCollection documentContext, String xslTemplate)	This method performs a XSL transformation based on an xslTemplate.

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

close, getCtx, getWorkflowService, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

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

Field Details

ITEM_DOCUMENT_COMPOSER

public static String ITEM_DOCUMENT_COMPOSER

INVALID_DATA_OBJECT

public static String INVALID_DATA_OBJECT

INVALID_XSL_FORMAT

public static String INVALID_XSL_FORMAT

Constructor Details

DocumentComposerPlugin

public DocumentComposerPlugin()

Method Details

init

public void init(WorkflowContext actx)
          throws PluginException

Description copied from class: AbstractPlugin

Initialize Plugin and get an instance of the EJB Session Context

Specified by:

init in interface Plugin

Overrides:

init in class AbstractPlugin

Parameters:

actx - defines the context in which the plugin runs. The context can be used to get information about the environment

Throws:

PluginException

run

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

This method adds the attachments of the blob workitem to the MimeMessage

Parameters:

documentContext - the workitem to be processed

event - the workflow event containing the processing instructions

Returns:

updated workitem for further processing

Throws:

PluginException

transformXSLTemplate

public String transformXSLTemplate(ItemCollection documentContext,
 String xslTemplate)
                            throws PluginException

This method performs a XSL transformation based on an xslTemplate. The xml source is generated form the current document context. encoding is set to UTF-8

Returns:

translated email body

Throws:

PluginException