org.bonitasoft.engine.external.permission

Class IsInvolvedInHumanTask

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.external.permission.IsInvolvedInHumanTask

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class IsInvolvedInHumanTask
extends CommandWithParameters

Specific Command to know if a user is involved in a specific human task. The mandatory keys to set as parameter are "USER_ID_KEY" and "HUMAN_TASK_INSTANCE_ID_KEY".

Author:

Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DO_FOR_KEY
protected static String	HUMAN_TASK_INSTANCE_ID_KEY
protected static String	USER_ID_KEY

Constructor Summary

Constructors

Constructor and Description
IsInvolvedInHumanTask()

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	execute(Map<String,Serializable> parameters, TenantServiceAccessor serviceAccessor) Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command.
protected org.bonitasoft.engine.session.model.SSession	getCurrentSession() method created for stubbing purpose

Methods inherited from class org.bonitasoft.engine.command.system.CommandWithParameters

getIntegerMandadoryParameter, getLongMandadoryParameter, getMandatoryParameter, getParameter, getParameter, getStringMandadoryParameter

Methods inherited from class java.lang.Object

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

Field Detail

USER_ID_KEY

protected static final String USER_ID_KEY

See Also:

Constant Field Values

DO_FOR_KEY

protected static final String DO_FOR_KEY

See Also:

Constant Field Values

HUMAN_TASK_INSTANCE_ID_KEY

protected static final String HUMAN_TASK_INSTANCE_ID_KEY

See Also:

Constant Field Values

Constructor Detail

IsInvolvedInHumanTask

public IsInvolvedInHumanTask()

Method Detail

execute

public Serializable execute(Map<String,Serializable> parameters,
                   TenantServiceAccessor serviceAccessor)
                     throws SCommandParameterizationException,
                            SCommandExecutionException

Description copied from interface: Command

Method that is called by the engine on the server side when the client calls CommandAPI#execute(String, Map) with the name or id of this command. Implementors of commands must put here the code to be executed on the server side

Parameters:

parameters - a map of parameters that can be used by the command and that is given by the client when executing the command

serviceAccessor - the TenantServiceAccessor or PlatformServiceAccessor that provides access to the engine's server-side services

Returns:

a Boolean : - true, if the user is involved in t human task; - false, otherwise.

Throws:

SCommandParameterizationException - can be thrown if insufficient or wrong parameters are given by the client

SCommandExecutionException - can be thrown when something unexpected happens while executing the command

getCurrentSession

protected org.bonitasoft.engine.session.model.SSession getCurrentSession()

method created for stubbing purpose

Returns:

current session