org.imixs.workflow.engine.adminp

Class JobHandlerRenameUser

java.lang.Object

org.imixs.workflow.engine.adminp.JobHandlerRenameUser

All Implemented Interfaces:

JobHandler

@DeclareRoles(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
 @RunAs(value="org.imixs.ACCESSLEVEL.MANAGERACCESS")
public class JobHandlerRenameUser
extends Object
implements JobHandler

The JobHandlerRenameUser updates the name fields of workitems. A name can be replaced or added. The following job attributes are expected:

• namFrom - source userID
• namTo - target userID
• keyReplace - if true the source UserID will be replaced with the target UserID, otherwise the target userID will be added

The jobHandler only processes workitems from the type

• workitem
• childworkitem
• workitemlob

The following workitem attributes will be updated:

• $writeaccess
• $readaccess
• namowner
• $creator
• namcreator (deprecated)

The attributes $creator can not be replaced. Only an additional userID is placed here.

Version:

1.0

See Also:

AdminPService for details

Constructor Summary

Constructors

Constructor and Description
JobHandlerRenameUser()

Method Summary

Modifier and Type	Method and Description
boolean	run(ItemCollection adminp) This method creates a new AdminP Job to rename userId in workitems.
ItemCollection	saveJobEntity(ItemCollection adminp) Save AdminP Entity
boolean	updateWorkitemUserIds(ItemCollection entity, String from, String to, boolean replace) Updates read,write and owner of a entity and returns true if an update was necessary

Methods inherited from class java.lang.Object

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

Constructor Detail

JobHandlerRenameUser

public JobHandlerRenameUser()

Method Detail

run

public boolean run(ItemCollection adminp)
            throws AdminPException

This method creates a new AdminP Job to rename userId in workitems.

Specified by:

run in interface JobHandler

Returns:

Throws:

QueryException

AccessDeniedException

AdminPException

updateWorkitemUserIds

public boolean updateWorkitemUserIds(ItemCollection entity,
                                     String from,
                                     String to,
                                     boolean replace)
                              throws AccessDeniedException

Updates read,write and owner of a entity and returns true if an update was necessary

Parameters:

entity -

from -

to -

replace -

Returns:

true if the entiy was modified.

Throws:

AccessDeniedException

saveJobEntity

public ItemCollection saveJobEntity(ItemCollection adminp)
                             throws AccessDeniedException

Save AdminP Entity

Throws:

AccessDeniedException