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 String	ACTIVITY_INSTANCE_ID_KEY
static 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

Methods

Modifier and Type	Method and Description
protected void	addSystemCommentOnProcessInstanceWhenExecutingTaskFor(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance, long executerUserId, long executerSubstituteUserId)
Serializable	execute(Map<String,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(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance, long executerUserId)
protected Long	getActivityInstanceId(Map<String,Serializable> parameters)
protected Long	getExecuteByUserId(Map<String,Serializable> parameters)
protected List<Operation>	getOperations(Map<String,Serializable> parameters)
protected Map<String,Serializable>	getOperationsContext(Map<String,Serializable> parameters)
protected void	updateActivityInstanceVariables(List<Operation> operations, Map<String,Serializable> operationsContext, long activityInstanceId, Long processDefinitionID)

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

getLocalClassLoader, getProcessDefinition, getProcessInstance, getSActivityInstance, 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 String ACTIVITY_INSTANCE_ID_KEY

See Also:

Constant Field Values

USER_ID_KEY

public static final String USER_ID_KEY

See Also:

Constant Field Values

Constructor Detail

ExecuteActionsAndTerminateTask

public ExecuteActionsAndTerminateTask()

Method Detail

execute

public Serializable execute(Map<String,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 Long getExecuteByUserId(Map<String,Serializable> parameters)

getActivityInstanceId

protected Long getActivityInstanceId(Map<String,Serializable> parameters)
                              throws SCommandParameterizationException

Throws:

SCommandParameterizationException

getOperations

protected List<Operation> getOperations(Map<String,Serializable> parameters)
                                 throws SCommandParameterizationException

Throws:

SCommandParameterizationException

getOperationsContext

protected Map<String,Serializable> getOperationsContext(Map<String,Serializable> parameters)
                                                 throws SCommandParameterizationException

Throws:

SCommandParameterizationException

updateActivityInstanceVariables

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

Throws:

org.bonitasoft.engine.core.operation.exception.SOperationExecutionException

executeActivity

protected void executeActivity(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance,
                   long executerUserId)
                        throws org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeReadException,
                               org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

Throws:

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeReadException

org.bonitasoft.engine.core.process.instance.api.exceptions.SFlowNodeExecutionException

addSystemCommentOnProcessInstanceWhenExecutingTaskFor

protected void addSystemCommentOnProcessInstanceWhenExecutingTaskFor(org.bonitasoft.engine.core.process.instance.model.SFlowNodeInstance flowNodeInstance,
                                                         long executerUserId,
                                                         long executerSubstituteUserId)