org.camunda.bpm.engine.impl

Class SignalEventReceivedBuilderImpl

java.lang.Object

org.camunda.bpm.engine.impl.SignalEventReceivedBuilderImpl

All Implemented Interfaces:

SignalEventReceivedBuilder

public class SignalEventReceivedBuilderImpl
extends Object
implements SignalEventReceivedBuilder

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandExecutor	commandExecutor
protected String	executionId
protected boolean	isTenantIdSet
protected String	signalName
protected String	tenantId
protected VariableMap	variables

Constructor Summary

Constructors

Constructor and Description
SignalEventReceivedBuilderImpl(CommandExecutor commandExecutor, String signalName)

Method Summary

Modifier and Type	Method and Description
SignalEventReceivedBuilder	executionId(String executionId) Specify a single execution to deliver the signal to.
String	getExecutionId()
String	getSignalName()
String	getTenantId()
VariableMap	getVariables()
boolean	isTenantIdSet()
void	send() Delivers the signal to waiting executions and process definitions.
SignalEventReceivedBuilder	setVariables(Map<String,Object> variables) Add the given variables to the triggered executions.
SignalEventReceivedBuilder	tenantId(String tenantId) Specify a tenant to deliver the signal to.
SignalEventReceivedBuilder	withoutTenantId() Specify that the signal can only be received on executions or process definitions which belongs to no tenant.

Methods inherited from class java.lang.Object

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

Field Detail

commandExecutor

protected final CommandExecutor commandExecutor

signalName

protected final String signalName

executionId

protected String executionId

tenantId

protected String tenantId

isTenantIdSet

protected boolean isTenantIdSet

variables

protected VariableMap variables

Constructor Detail

SignalEventReceivedBuilderImpl

public SignalEventReceivedBuilderImpl(CommandExecutor commandExecutor,
                                      String signalName)

Method Detail

setVariables

public SignalEventReceivedBuilder setVariables(Map<String,Object> variables)

Description copied from interface: SignalEventReceivedBuilder

Add the given variables to the triggered executions.

Specified by:

setVariables in interface SignalEventReceivedBuilder

Parameters:

variables - a map of variables added to the executions

Returns:

the builder

executionId

public SignalEventReceivedBuilder executionId(String executionId)

Description copied from interface: SignalEventReceivedBuilder

Specify a single execution to deliver the signal to.

Specified by:

executionId in interface SignalEventReceivedBuilder

Parameters:

executionId - the id of the process instance or the execution to deliver the signal to

Returns:

the builder

tenantId

public SignalEventReceivedBuilder tenantId(String tenantId)

Description copied from interface: SignalEventReceivedBuilder

Specify a tenant to deliver the signal to. The signal can only be received on executions or process definitions which belongs to the given tenant. Cannot be used in combination with SignalEventReceivedBuilder.executionId(String).

Specified by:

tenantId in interface SignalEventReceivedBuilder

Parameters:

tenantId - the id of the tenant

Returns:

the builder

withoutTenantId

public SignalEventReceivedBuilder withoutTenantId()

Description copied from interface: SignalEventReceivedBuilder

Specify that the signal can only be received on executions or process definitions which belongs to no tenant. Cannot be used in combination with SignalEventReceivedBuilder.executionId(String).

Specified by:

withoutTenantId in interface SignalEventReceivedBuilder

Returns:

the builder

send

public void send()

Description copied from interface: SignalEventReceivedBuilder

Delivers the signal to waiting executions and process definitions. The notification and instantiation happen synchronously.

Note that the signal delivers to all tenants if no tenant is specified using SignalEventReceivedBuilder.tenantId(String) or SignalEventReceivedBuilder.withoutTenantId().

Specified by:

send in interface SignalEventReceivedBuilder

getSignalName

public String getSignalName()

getExecutionId

public String getExecutionId()

getTenantId

public String getTenantId()

isTenantIdSet

public boolean isTenantIdSet()

getVariables

public VariableMap getVariables()