org.bonitasoft.engine.external.process

Class GetUpdatedVariableValuesForProcessInstance

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.external.process.UpdateVariableValuesThroughOperations

org.bonitasoft.engine.external.process.GetUpdatedVariableValuesForProcessInstance

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class GetUpdatedVariableValuesForProcessInstance
extends UpdateVariableValuesThroughOperations

Author:

Emmanuel Duchastenier

Field Summary

Fields inherited from class org.bonitasoft.engine.external.process.UpdateVariableValuesThroughOperations

CURRENT_VARIABLE_VALUES_MAP_KEY, OPERATIONS_INPUT_KEY, OPERATIONS_LIST_KEY

Constructor Summary

Constructors

Constructor and Description
GetUpdatedVariableValuesForProcessInstance()

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 void	executeOperation(Operation operation, Map<String,Serializable> operationsInputValues, Map<String,Serializable> currentVariableValues, long processInstanceId)
long	getProcessDefinitionId(long containerInstanceId)
TenantServiceAccessor	getServiceAccessor()

Methods inherited from class org.bonitasoft.engine.external.process.UpdateVariableValuesThroughOperations

updateVariablesThroughOperations

Methods inherited from class java.lang.Object

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

Constructor Detail

GetUpdatedVariableValuesForProcessInstance

public GetUpdatedVariableValuesForProcessInstance()

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 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

executeOperation

protected void executeOperation(Operation operation,
                    Map<String,Serializable> operationsInputValues,
                    Map<String,Serializable> currentVariableValues,
                    long processInstanceId)
                         throws org.bonitasoft.engine.commons.exceptions.SBonitaException

Specified by:

executeOperation in class UpdateVariableValuesThroughOperations

Throws:

org.bonitasoft.engine.commons.exceptions.SBonitaException

getServiceAccessor

public TenantServiceAccessor getServiceAccessor()

Specified by:

getServiceAccessor in class UpdateVariableValuesThroughOperations

getProcessDefinitionId

public long getProcessDefinitionId(long containerInstanceId)
                            throws org.bonitasoft.engine.core.process.instance.api.exceptions.SProcessInstanceNotFoundException,
                                   org.bonitasoft.engine.core.process.instance.api.exceptions.SProcessInstanceReadException

Specified by:

getProcessDefinitionId in class UpdateVariableValuesThroughOperations

Throws:

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

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