org.imixs.marty.team

Class TeamPlugin

java.lang.Object

org.imixs.workflow.engine.plugins.AbstractPlugin

org.imixs.marty.team.TeamPlugin

All Implemented Interfaces:

org.imixs.workflow.Plugin

Direct Known Subclasses:

TeamPlugin

public class TeamPlugin
extends org.imixs.workflow.engine.plugins.AbstractPlugin

The Marty TeamPlugin organizes the hierarchical order of a workitem between processes, spaces and workitems. A WorkItem is typically assigned to a process and a optional to one ore more space entities. These references are stored in the $UniqueIDRef property of the WorkItem. In addition to the $UniqueIDRef property the TeamPlugin manages the properties process.ref and space.ref which containing only uniqueIDs of the corresponding entity type. The properties process.ref and space.ref can be modified by an application to reassign the workitem.

This plug-in supports also additional workflow properties for further processing. The method computes the team members and the name of the assigned process and space.

The TeamPlugin updates the following properties:

• space.team
• space.Manager
• space.Assist
• space.Name
• space.ref
• process.Team
• process.Manager
• process.Assist
• process.name
• process.ref

The name properties are used in security and mail plug-ins.

The properties 'process.ref' and 'space.ref' are optional and can provide the current $uniqueIDs for referenced space or process entities. The Plug-in updates the $UniqueIDRef property if these properties are filled.

If the workItem is a child to another workItem (ChildWorkitem) the information is fetched from the parent workItem.

If the workflowresultmessage of the ActivityEntity contains a space or process reference the plug-in will update the reference in the property $uniqueIdRef.

Example: ... ... The Plug-in should run before Access-, Application- and Mail-Plug-in. Note: the deprecated item names are still supported:

• namSpaceTeam
• namSpaceManager
• namSpaceAssist
• namSpaceName
• namProcessTeam
• namProcessManager
• namProcessAssist
• txtSpaceName
• txtProcessName

Version:

2.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_REFERENCE_ASSIGNED_BY_MODEL
static String	NO_PROCESS_ASSIGNED

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

INVALID_ITEMVALUE_FORMAT, INVALID_PROPERTYVALUE_FORMAT

Constructor Summary

Constructors

Constructor and Description
TeamPlugin()

Method Summary

Modifier and Type	Method and Description
org.imixs.workflow.ItemCollection	findEntity(String id) Helper method to lookup an entity in internal cache or load it from database
void	init(org.imixs.workflow.WorkflowContext actx) Fetch workflowService and entityService from WorkflowContext
org.imixs.workflow.ItemCollection	run(org.imixs.workflow.ItemCollection workItem, org.imixs.workflow.ItemCollection documentActivity) The method updates information from the Process and Space entiy (optional) stored in the attribute '$uniqueIdref' process.ref space.ref namTeam namManager namProcessTeam namProcessManager txtSpaceName txtCoreProcessName If the workitem is a child to another workitem (ChildWorkitem) the information is fetched from the parent workitem.

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

close, getCtx, getWorkflowService, mergeFieldList, uniqueList

Methods inherited from class java.lang.Object

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

Field Detail

INVALID_REFERENCE_ASSIGNED_BY_MODEL

public static final String INVALID_REFERENCE_ASSIGNED_BY_MODEL

See Also:

Constant Field Values

NO_PROCESS_ASSIGNED

public static final String NO_PROCESS_ASSIGNED

See Also:

Constant Field Values

Constructor Detail

TeamPlugin

public TeamPlugin()

Method Detail

init

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

Fetch workflowService and entityService from WorkflowContext

Specified by:

init in interface org.imixs.workflow.Plugin

Overrides:

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

Throws:

org.imixs.workflow.exceptions.PluginException

run

public org.imixs.workflow.ItemCollection run(org.imixs.workflow.ItemCollection workItem,
                                             org.imixs.workflow.ItemCollection documentActivity)
                                      throws org.imixs.workflow.exceptions.PluginException

The method updates information from the Process and Space entiy (optional) stored in the attribute '$uniqueIdref'

• process.ref
• space.ref
• namTeam
• namManager
• namProcessTeam
• namProcessManager
• txtSpaceName
• txtCoreProcessName If the workitem is a child to another workitem (ChildWorkitem) the information is fetched from the parent workitem. If the workflowresultmessage contains a space entity reference the plugin will update the reference in the property $uniqueIdRef. Example: ...

Throws:

org.imixs.workflow.exceptions.PluginException

findEntity

public org.imixs.workflow.ItemCollection findEntity(String id)

Helper method to lookup an entity in internal cache or load it from database

Parameters:

id -

Returns:

entity or null if not exits