Class MinutePlugin

  • All Implemented Interfaces:
    org.imixs.workflow.Plugin

    public class MinutePlugin
    extends org.imixs.workflow.engine.plugins.AbstractPlugin
    This Plugin controls MinuteItems of a parent workflow.

    A MinuteItem can be of any type (e.g. 'workitem' or 'childworkitem'). The plugin number all MinuteItems automatically with a continuing numSequenceNumber. The attribute 'minutetype' indicates if a workitem is a minuteparent or a minuteitem.

    When a new MinuteItem is created or has no sequencenumber, the plugin computes the next sequencenumber automatically.

    In case the minute parent is a version (UNIQUEIDSOURCE), than the plugin copies all MinuteItems from the master and renumbers the MinuteItems (sequencenumber).

    The Plugin manges the items 'minuteparent' and 'minuteitem'. These items hold a $uniqueID for the corresponding parent or minute entity.

    If the Event sets the item 'resetminuteversionhistory' to the boolean value 'true', the plugin will reset the version history.

    Version:
    2.0
    Author:
    rsoika
    • Constructor Summary

      Constructors 
      Constructor Description
      MinutePlugin()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected List<org.imixs.workflow.ItemCollection> explodeChildList​(org.imixs.workflow.ItemCollection workitem)
      converts the Map List of a workitem into a List of ItemCollectons
      protected void implodeChildList​(org.imixs.workflow.ItemCollection workitem, List<org.imixs.workflow.ItemCollection> childItems)
      Convert the List of ItemCollections back into a List of Map elements
      org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection documentContext, org.imixs.workflow.ItemCollection documentActivity)
      If a version was created, all workitems from the master with the types 'workitem' or 'childworkitem' are copied into the new version.
      • Methods inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin

        close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList
    • Constructor Detail

      • MinutePlugin

        public MinutePlugin()
    • Method Detail

      • run

        public org.imixs.workflow.ItemCollection run​(org.imixs.workflow.ItemCollection documentContext,
                                                     org.imixs.workflow.ItemCollection documentActivity)
                                              throws org.imixs.workflow.exceptions.PluginException
        If a version was created, all workitems from the master with the types 'workitem' or 'childworkitem' are copied into the new version.
        Returns:
        Throws:
        org.imixs.workflow.exceptions.PluginException
        javax.mail.internet.AddressException
      • implodeChildList

        protected void implodeChildList​(org.imixs.workflow.ItemCollection workitem,
                                        List<org.imixs.workflow.ItemCollection> childItems)
        Convert the List of ItemCollections back into a List of Map elements
        Parameters:
        workitem -
      • explodeChildList

        protected List<org.imixs.workflow.ItemCollection> explodeChildList​(org.imixs.workflow.ItemCollection workitem)
        converts the Map List of a workitem into a List of ItemCollectons