Package org.camunda.bpm.engine.runtime
Interface SignalEventReceivedBuilder
- All Known Implementing Classes:
SignalEventReceivedBuilderImpl
public interface SignalEventReceivedBuilder
Fluent builder to notify the process engine that a signal event has been
received.
-
Method Summary
Modifier and TypeMethodDescriptionexecutionId
(String executionId) Specify a single execution to deliver the signal to.void
send()
Delivers the signal to waiting executions and process definitions.setVariables
(Map<String, Object> variables) Add the given variables to the triggered executions.Specify a tenant to deliver the signal to.Specify that the signal can only be received on executions or process definitions which belongs to no tenant.
-
Method Details
-
setVariables
Add the given variables to the triggered executions.- Parameters:
variables
- a map of variables added to the executions- Returns:
- the builder
-
executionId
Specify a single execution to deliver the signal to.- Parameters:
executionId
- the id of the process instance or the execution to deliver the signal to- Returns:
- the builder
-
tenantId
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 withexecutionId(String)
.- Parameters:
tenantId
- the id of the tenant- Returns:
- the builder
-
withoutTenantId
SignalEventReceivedBuilder withoutTenantId()Specify that the signal can only be received on executions or process definitions which belongs to no tenant. Cannot be used in combination withexecutionId(String)
.- Returns:
- the builder
-
send
void send()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
tenantId(String)
orwithoutTenantId()
.- Throws:
ProcessEngineException
- if a single execution is specified and no such execution exists or has not subscribed to the signalAuthorizationException
-- if notify an execution and the user has no
Permissions.UPDATE
permission onResources.PROCESS_INSTANCE
or noPermissions.UPDATE_INSTANCE
permission onResources.PROCESS_DEFINITION
.- if start a new process instance and the user has no
Permissions.CREATE
permission onResources.PROCESS_INSTANCE
and noPermissions.CREATE_INSTANCE
permission onResources.PROCESS_DEFINITION
.- if notify an execution and the user has no
-