org.bonitasoft.engine.external.web.forms

Class ExecuteActionsAndTerminateTask

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.command.system.CommandWithParameters

org.bonitasoft.engine.external.web.forms.ExecuteActionsBaseEntry

org.bonitasoft.engine.external.web.forms.ExecuteActionsAndTerminateTask

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class ExecuteActionsAndTerminateTask
extends ExecuteActionsBaseEntry

Author:

Ruiheng Fan, Baptiste Mesta, Elias Ricken de Medeiros, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVITY_INSTANCE_ID_KEY
static java.lang.String	USER_ID_KEY

Fields inherited from class org.bonitasoft.engine.external.web.forms.ExecuteActionsBaseEntry

CONNECTORS_LIST_KEY, OPERATIONS_INPUT_KEY, OPERATIONS_LIST_KEY, PROCESS_DEFINITION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
ExecuteActionsAndTerminateTask()

Method Summary

Modifier and Type	Method and Description
protected void	addSystemCommentOnProcessInstanceWhenExecutingTaskFor(SFlowNodeInstance flowNodeInstance, long executerUserId, long executerSubstituteUserId)
java.io.Serializable	execute(java.util.Map<java.lang.String,java.io.Serializable> parameters, TenantServiceAccessor tenantAccessor) 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 void	executeActivity(SFlowNodeInstance flowNodeInstance, long executerUserId)
protected java.lang.Long	getActivityInstanceId(java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected java.lang.Long	getExecuteByUserId(java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected java.util.List<org.bonitasoft.engine.operation.Operation>	getOperations(java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected java.util.Map<java.lang.String,java.io.Serializable>	getOperationsContext(java.util.Map<java.lang.String,java.io.Serializable> parameters)
protected void	updateActivityInstanceVariables(java.util.List<org.bonitasoft.engine.operation.Operation> operations, java.util.Map<java.lang.String,java.io.Serializable> operationsContext, long activityInstanceId, java.lang.Long processDefinitionID)

Methods inherited from class org.bonitasoft.engine.external.web.forms.ExecuteActionsBaseEntry

getTenantAccessor, getTenantId, log

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

ACTIVITY_INSTANCE_ID_KEY

public static final java.lang.String ACTIVITY_INSTANCE_ID_KEY

See Also:

Constant Field Values

USER_ID_KEY

public static final java.lang.String USER_ID_KEY

See Also:

Constant Field Values

Constructor Detail

ExecuteActionsAndTerminateTask

public ExecuteActionsAndTerminateTask()

Method Detail

execute

public java.io.Serializable execute(java.util.Map<java.lang.String,java.io.Serializable> parameters,
                                    TenantServiceAccessor tenantAccessor)
                             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

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

Returns:

a result that will be returned to the client

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

getExecuteByUserId

protected java.lang.Long getExecuteByUserId(java.util.Map<java.lang.String,java.io.Serializable> parameters)

getActivityInstanceId

protected java.lang.Long getActivityInstanceId(java.util.Map<java.lang.String,java.io.Serializable> parameters)
                                        throws SCommandParameterizationException

Throws:

SCommandParameterizationException

getOperations

protected java.util.List<org.bonitasoft.engine.operation.Operation> getOperations(java.util.Map<java.lang.String,java.io.Serializable> parameters)
                                                                           throws SCommandParameterizationException

Throws:

SCommandParameterizationException

getOperationsContext

protected java.util.Map<java.lang.String,java.io.Serializable> getOperationsContext(java.util.Map<java.lang.String,java.io.Serializable> parameters)
                                                                             throws SCommandParameterizationException

Throws:

SCommandParameterizationException

updateActivityInstanceVariables

protected void updateActivityInstanceVariables(java.util.List<org.bonitasoft.engine.operation.Operation> operations,
                                               java.util.Map<java.lang.String,java.io.Serializable> operationsContext,
                                               long activityInstanceId,
                                               java.lang.Long processDefinitionID)
                                        throws SOperationExecutionException

Throws:

SOperationExecutionException

executeActivity

protected void executeActivity(SFlowNodeInstance flowNodeInstance,
                               long executerUserId)
                        throws SFlowNodeReadException,
                               SFlowNodeExecutionException

Throws:

SFlowNodeReadException

SFlowNodeExecutionException

addSystemCommentOnProcessInstanceWhenExecutingTaskFor

protected void addSystemCommentOnProcessInstanceWhenExecutingTaskFor(SFlowNodeInstance flowNodeInstance,
                                                                     long executerUserId,
                                                                     long executerSubstituteUserId)