com.axemble.vdoc.sdk.interfaces

Interface IDelegationController

All Superinterfaces:

IController, Serializable

public interface IDelegationController
extends IController

The IDelegationController interface allows you to either replace of delegate objects which supports delegation.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

ICatalog, IWorkflowContainer, IWorkflow, ITask, IWorkflowInstance

Method Summary

Modifier and Type	Method and Description
void	addDelegation(IUser user, IUser substituteUser) Add a delegation unit to all objects which support delegation on a server scope
void	addDelegation(IUser user, IUser substituteUser, IDelegationSupport delegationSupport) Add a delegation unit to any object which supports delegation
void	addDelegation(IUser user, IUser substituteUser, IDelegationSupport delegationSupport, String comment) Add a delegation unit to any object which supports delegation
void	addDelegation(IUser user, IUser substituteUser, IWorkflowInstance workflowInstance, ITask task) Add a delegation unit to a specific workflow instance for a user in the context of a task
void	breakDelegation(IUser user, IDelegationSupport delegationSupport) Break a delegation unit.
void	breakDelegation(IUser user, IWorkflowInstance workflowInstance, ITask task) Break a delegation unit.
void	delegate(IUser user, IUser substituteUser, ITaskInstance taskInstance) Delegate a specific task instance.
IReport	delegateOperatorRoles(ICatalog catalog, Collection<? extends IOperatorRole> roles, IUser user, IUser substituteUser) Allow to replace a user for the operator roles
IReport	delegateProfiles(ICatalog catalog, Collection<? extends IProfile> profiles, IUser user, IUser substituteUser) Allow to replace a user for the profiles
IReport	delegateResources(ICatalog catalog, Collection<? extends IOperatorRole> roles, Collection<? extends IWorkflowInstance> resources, IUser user, IUser substituteUser) Allow to replace a user for a specified set of workflow instances
IReport	delegateRoles(ICatalog catalog, Collection<? extends IRole> roles, Collection<? extends IWorkflowInstance> resources, IUser user, IUser substituteUser) Deprecated. : use delegateOperatorRoles or delegateProfiles
void	removeDelegation(IUser user) Remove a delegation unit for all objects which support delegation on a server scope
void	removeDelegation(IUser user, IDelegationSupport delegationSupport) Remove a delegation unit for a particular user
void	removeDelegation(IUser user, IWorkflowInstance workflowInstance, ITask task) Remove a delegation unit for a particular user and a specific task

Method Detail

addDelegation

void addDelegation(IUser user,
                   IUser substituteUser)

Add a delegation unit to all objects which support delegation on a server scope

Parameters:

user - The user to replace

substituteUser - The next fulfiller

removeDelegation

void removeDelegation(IUser user)

Remove a delegation unit for all objects which support delegation on a server scope

Parameters:

user -

addDelegation

void addDelegation(IUser user,
                   IUser substituteUser,
                   IDelegationSupport delegationSupport)

Add a delegation unit to any object which supports delegation

Parameters:

user - The user to replace

substituteUser - The next fulfiller

delegationSupport - The object which supports delegation

addDelegation

void addDelegation(IUser user,
                   IUser substituteUser,
                   IDelegationSupport delegationSupport,
                   String comment)

Add a delegation unit to any object which supports delegation

Parameters:

user - The user to replace

substituteUser - The next fulfiller

delegationSupport - The object which supports delegation

comment -

removeDelegation

void removeDelegation(IUser user,
                      IDelegationSupport delegationSupport)

Remove a delegation unit for a particular user

Parameters:

user -

delegationSupport -

breakDelegation

void breakDelegation(IUser user,
                     IDelegationSupport delegationSupport)

Break a delegation unit. It prevents an embedded object from being delegated

Parameters:

user -

delegationSupport -

addDelegation

void addDelegation(IUser user,
                   IUser substituteUser,
                   IWorkflowInstance workflowInstance,
                   ITask task)

Add a delegation unit to a specific workflow instance for a user in the context of a task

Parameters:

user -

substituteUser -

workflowInstance -

task -

removeDelegation

void removeDelegation(IUser user,
                      IWorkflowInstance workflowInstance,
                      ITask task)

Remove a delegation unit for a particular user and a specific task

Parameters:

user -

workflowInstance -

task -

breakDelegation

void breakDelegation(IUser user,
                     IWorkflowInstance workflowInstance,
                     ITask task)

Break a delegation unit. It prevents an embedded object from being delegated

Parameters:

user -

workflowInstance -

task -

delegate

void delegate(IUser user,
              IUser substituteUser,
              ITaskInstance taskInstance)

Delegate a specific task instance.

Parameters:

user -

substituteUser -

taskInstance -

delegateResources

IReport delegateResources(ICatalog catalog,
                          Collection<? extends IOperatorRole> roles,
                          Collection<? extends IWorkflowInstance> resources,
                          IUser user,
                          IUser substituteUser)

Allow to replace a user for a specified set of workflow instances

Parameters:

catalog -

roles -

resources -

user -

substituteUser -

Returns:

A IReport object.

delegateRoles

@Deprecated
IReport delegateRoles(ICatalog catalog,
                                  Collection<? extends IRole> roles,
                                  Collection<? extends IWorkflowInstance> resources,
                                  IUser user,
                                  IUser substituteUser)

Deprecated. : use delegateOperatorRoles or delegateProfiles

Allow to replace a user for the roles

Parameters:

catalog -

roles -

resources -

user -

substituteUser -

Returns:

A IReport object.

delegateOperatorRoles

IReport delegateOperatorRoles(ICatalog catalog,
                              Collection<? extends IOperatorRole> roles,
                              IUser user,
                              IUser substituteUser)

Allow to replace a user for the operator roles

Parameters:

catalog -

roles -

user -

substituteUser -

Returns:

report

delegateProfiles

IReport delegateProfiles(ICatalog catalog,
                         Collection<? extends IProfile> profiles,
                         IUser user,
                         IUser substituteUser)

Allow to replace a user for the profiles

Parameters:

catalog -

profiles -

user -

substituteUser -

Returns:

A IReport object.