org.imixs.workflow.plugins
Class OwnerPlugin

java.lang.Object
  org.imixs.workflow.plugins.OwnerPlugin

All Implemented Interfaces:

Plugin

public class OwnerPlugin
extends Object
implements Plugin

This Pluginmodul implements a Ownership Control for Workflowactivitys. The Plugin manages the modifications of the field namOwner of a Workitem inside a activity by setting this Attribute. A Workflowmanager can use this attributes to reflect there settings to the ownership inside a certain databasesystem. The Plugin checks a set of activity attributes to manage the new settings of the ownership defined inside the activity entity These attributes are: o keyOwnershipMode (Vector): '1'=modify access '0'=renew access o namOwnershipNames (Vector): Names & Groups to add to the namOwner (Vector): o keyaddwriteroles (Vector): Roles to add to the namOwner attribute

Version:

1.0

Author:

Ralph Soika

See Also:

WorkflowManager

Field Summary

Fields inherited from interface org.imixs.workflow.Plugin

PLUGIN_ERROR, PLUGIN_OK, PLUGIN_WARNING

Constructor Summary

OwnerPlugin()

Method Summary

void	close(int status) This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data
void	init(WorkflowContext actx) The init Methode is usesd to initialize the plugin.
int	run(ItemCollection adocumentContext, ItemCollection adocumentActivity) changes the namworkflowreadaccess and namworkflowwriteaccess attribues depending to the activityentity

Methods inherited from class java.lang.Object

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

Constructor Detail

OwnerPlugin

public OwnerPlugin()

Method Detail

init

public void init(WorkflowContext actx)
          throws Exception

Description copied from interface: Plugin

The init Methode is usesd to initialize the plugin.

Specified by:

init in interface Plugin

Parameters:

actx - defines the context in which the plugin runs a Plugin can use this context to get information about the enviroment

Throws:

Exception

run

public int run(ItemCollection adocumentContext,
               ItemCollection adocumentActivity)
        throws Exception

changes the namworkflowreadaccess and namworkflowwriteaccess attribues depending to the activityentity

Specified by:

run in interface Plugin

Parameters:

adocumentContext - defines the document to be processed

adocumentActivity - defines the activity document which contains the workflowprocessing instructions

Returns:

the current status for this plugin

Throws:

Exception

close

public void close(int status)
           throws Exception

Description copied from interface: Plugin

This CallBack Mathode is uses to giv the plugin the chance to close plubin spcific data

Specified by:

close in interface Plugin

Parameters:

status - gives the plugin information about the current status. this parameter is deliverd by the workflowKernel.

Throws:

Exception