Class DeputyPlugin

java.lang.Object
org.imixs.workflow.engine.plugins.AbstractPlugin
org.imixs.marty.profile.DeputyPlugin
All Implemented Interfaces:
org.imixs.workflow.Plugin
Direct Known Subclasses:
DeputyPlugin

public class DeputyPlugin extends org.imixs.workflow.engine.plugins.AbstractPlugin
This plugin computes for each name field (prefix = 'nam') if the corresponding user profile contains a deputy. If so the deputy will be added into the name field. If a name Field (prafix = 'nam') is listed in the 'ignoreList' the field will be skipped. The ignoreList can include regular expressions and can be modified by a client. The plugin runs on all kinds of workitems and childworkitems. The Plugin should run after the TeamPlugin but before the ownerPlugin, approverPlugin and accessPlugin To avoid conflicts with the ApproverPlugin, the DeputyPlugin ignores fields ending with 'approvers' and 'approvedby'.
Author:
rsoika
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
     

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

    INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
     
    boolean
    ignoreItem(String itemName)
    This method returns true in case the given itemName must not be modified.
    org.imixs.workflow.ItemCollection
    run(org.imixs.workflow.ItemCollection aworkItem, org.imixs.workflow.ItemCollection documentActivity)
    iterate over all fields with the prefix nam...
    void
    setIgnoreList(String[] ignoreList)
     

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

    close, getCtx, getWorkflowService, init, mergeFieldList, uniqueList

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • PROFILESERVICE_NOT_BOUND

      public static String PROFILESERVICE_NOT_BOUND
  • Constructor Details

    • DeputyPlugin

      public DeputyPlugin()
  • Method Details

    • run

      public org.imixs.workflow.ItemCollection run(org.imixs.workflow.ItemCollection aworkItem, org.imixs.workflow.ItemCollection documentActivity)
      iterate over all fields with the prefix nam... Skip if not a workitem
    • getIgnoreList

      public String[] getIgnoreList()
    • setIgnoreList

      public void setIgnoreList(String[] ignoreList)
    • ignoreItem

      public boolean ignoreItem(String itemName)
      This method returns true in case the given itemName must not be modified. Regular expressions are supported by the ignoreList and supportList.
      Parameters:
      itemName -
      Returns:
      true if fieldName matches the ignoreList