org.imixs.workflow.jaxrs.plugins

Class ReportPlugin

java.lang.Object

org.imixs.workflow.plugins.AbstractPlugin

org.imixs.workflow.plugins.jee.AbstractPlugin

org.imixs.workflow.jaxrs.plugins.ReportPlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

public class ReportPlugin
extends AbstractPlugin

This plugin handles the creation of a Imixs Reoprt. The coresponding activityEntity provide the following properties:

• txtReportName=Name of the Report to be processed
• txtReportFilePath= filename or filepath the result will be saved
• txtReportTarget = where the result is saved (0=workitem, 1=blobWorkitem, 2= disk)

Version:

1.0

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_CONTEXT
static String	INVALID_REPORT_DEFINITION
static String	REPORT_UNDEFINED

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

Constructors

Constructor and Description
ReportPlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	close(int status)
void	init(org.imixs.workflow.WorkflowContext actx)
int	run(org.imixs.workflow.ItemCollection adocumentContext, org.imixs.workflow.ItemCollection adocumentActivity) creates report defined by the txtReportName.

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

getEjbSessionContext, getPropertyService, getUserName, replaceDynamicValues, setEjbSessionContext, setPropertyService

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

formatItemValues, formatItemValues, mergeMappedFieldValues, mergeVectors, uniqueList

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_CONTEXT

public static final String INVALID_CONTEXT

See Also:

Constant Field Values

REPORT_UNDEFINED

public static final String REPORT_UNDEFINED

See Also:

Constant Field Values

INVALID_REPORT_DEFINITION

public static final String INVALID_REPORT_DEFINITION

See Also:

Constant Field Values

Constructor Detail

ReportPlugin

public ReportPlugin()

Method Detail

init

public void init(org.imixs.workflow.WorkflowContext actx)
          throws org.imixs.workflow.exceptions.PluginException

Specified by:

init in interface org.imixs.workflow.Plugin

Overrides:

init in class AbstractPlugin

Throws:

org.imixs.workflow.exceptions.PluginException

run

public int run(org.imixs.workflow.ItemCollection adocumentContext,
      org.imixs.workflow.ItemCollection adocumentActivity)
        throws org.imixs.workflow.exceptions.PluginException

creates report defined by the txtReportName.

The method runs the EQL Statement defined in the corresponding Report definition to compute the collection of entities to be processed by a template.

As the current Workitem can not be identically included by the resultset of the EQL Statement (because the documentContext is yet not saved) the method tests if the resultset includes the current workitem. In this case the 'old' result will be replaced with the new currently processed workitem. The xml generated by the Jax-B Marshaller will be modified afterwards to avoid escaped content of fields with a name starting with 'xml' or 'html'.

Specified by:

run in interface org.imixs.workflow.Plugin

Specified by:

run in class AbstractPlugin

Throws:

org.imixs.workflow.exceptions.PluginException

close

public void close(int status)
           throws org.imixs.workflow.exceptions.PluginException

Specified by:

close in interface org.imixs.workflow.Plugin

Specified by:

close in class AbstractPlugin

Throws:

org.imixs.workflow.exceptions.PluginException