org.imixs.workflow.jaxrs.plugins
Class ReportPlugin

java.lang.Object
  org.imixs.workflow.plugins.AbstractPlugin
      org.imixs.workflow.jaxrs.plugins.ReportPlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

public class ReportPlugin
extends org.imixs.workflow.plugins.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 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

  ReportPlugin()
  

  Method Summary

  void	close(int status)
  org.imixs.workflow.jee.ejb.EntityService	getEntityService()
  org.imixs.workflow.jee.ejb.ReportService	getReportService()
  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.AbstractPlugin

  formatItemValues, getAbbreviateName, getCommonName, replaceDynamicValues

  Methods inherited from class java.lang.Object

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

  Constructor Detail

  ReportPlugin

  public ReportPlugin()

  Method Detail

  init

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

  Specified by:

  init in interface org.imixs.workflow.Plugin

  Overrides:

  init in class org.imixs.workflow.plugins.AbstractPlugin

  Throws:

  Exception

  getEntityService

  public org.imixs.workflow.jee.ejb.EntityService getEntityService()
                                                            throws Exception

  Throws:

  Exception

  getReportService

  public org.imixs.workflow.jee.ejb.ReportService getReportService()
                                                            throws Exception

  Throws:

  Exception

  run

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

  creates report defined by the txtReportName.

  The method runs the EQL Statement defined in the corepsonding Imixs Report 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.

  Throws:

  Exception

  close

  public void close(int status)
             throws Exception

  Throws:

  Exception