Package org.imixs.marty.plugins

Class CommentPlugin

  • All Implemented Interfaces:
    org.imixs.workflow.Plugin
    public class CommentPlugin
extends org.imixs.workflow.engine.plugins.AbstractPlugin
    This plugin supports a comment feature. Comments entered by a user into the field 'txtComment' are stored in the list property 'txtCommentList' which contains a map for each comment. The map stores the username, the timestamp and the comment. The plugin also stores the last comment in the field 'txtLastComment'. The comment can be also controlled by the corresponding workflow event: a new comment will not be added into the comment list xxx adds a fixed comment 'xxx' into the comment list
    Version:
    1.0
    Author:
    rsoika

    • Field Summary

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

        INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

    • Constructor Summary

      Constructors 
      Constructor Description
      CommentPlugin()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection adocumentContext, org.imixs.workflow.ItemCollection documentActivity)
      This method updates the comment list.

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

        close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList

    • Constructor Detail

      • CommentPlugin

        public CommentPlugin()

    • Method Detail

      • run

        public org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection adocumentContext,
                                             org.imixs.workflow.ItemCollection documentActivity)
                                      throws org.imixs.workflow.exceptions.PluginException
        This method updates the comment list. There for the method copies the txtComment into the txtCommentList and clears the txtComment field
        Parameters:
        workflowEvent -
        Throws:
        org.imixs.workflow.exceptions.PluginException