ApproverPlugin (Engine 6.0.3 API)

java.lang.Object
- org.imixs.workflow.engine.plugins.AbstractPlugin
- - org.imixs.workflow.engine.plugins.ApproverPlugin

All Implemented Interfaces:

Plugin
```
public class ApproverPlugin
extends AbstractPlugin
```
This plug-in is used to manage multiple users involved in a approver procedure. The list of approvers can be declared within the workflow result:
Example:
```
 
  <item name='approvedby'>ReviewTeam</item>
 
 
```
The tag value (e.g. 'ReviewTeam') declares the source item holding the users involved in the approver procedure. The plugin creates the following items to monitor the approver procedure:
```
 
  [SOURCEITEMNAME]$Approvers 
  [SOURCEITEMNAME]$ApprovedBy
 
 
```
If the source item is updated during the approving process, the plugin will add new userIDs if these new UserIDs are not yet listed in the item [SOURCEITEMNAME]$ApprovedBy.
If the attribute 'refresh' is set to true, the list [SOURCEITEMNAME]$Approvers will be updated (default is true).
If the attribute 'reset' is set to true, the list [SOURCEITEMNAME]$Approvers will be reseted and the item [SOURCEITEMNAME]$ApprovedBy will be cleared.
Version:

2.0

Author:

rsoika

Field Summary

Fields
Modifier and Type Field Description

static String APPROVEDBY

static String APPROVERS
- Fields inherited from class org.imixs.workflow.engine.plugins.AbstractPlugin
  INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors
Constructor Description

ApproverPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ItemCollection`	`run(ItemCollection workitem, ItemCollection event)`	computes the approvedBy and appovers name fields.

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 Detail

APPROVEDBY
```
public static String APPROVEDBY
```

APPROVERS
```
public static String APPROVERS
```

Constructor Detail
- ApproverPlugin
```
public ApproverPlugin()
```

Method Detail

run

public ItemCollection run(ItemCollection workitem,
                          ItemCollection event)
                   throws PluginException

computes the approvedBy and appovers name fields.

Throws:: PluginException