Package org.camunda.bpm.engine.delegate
Interface DelegateExecution
- All Superinterfaces:
BaseDelegateExecution
,BpmnModelExecutionContext
,ProcessEngineServicesAware
,VariableScope
- All Known Subinterfaces:
ActivityExecution
- All Known Implementing Classes:
ExecutionEntity
,ExecutionImpl
,PvmExecutionImpl
public interface DelegateExecution
extends BaseDelegateExecution, BpmnModelExecutionContext, ProcessEngineServicesAware
Execution used in
JavaDelegate
s and ExecutionListener
s.- Author:
- Tom Baeyens
-
Method Summary
Modifier and TypeMethodDescriptioncreateIncident
(String incidentType, String configuration) Create an incident associated with this executioncreateIncident
(String incidentType, String configuration, String message) Create an incident associated with this executionreturn the Id of the activity instance currently executed by this executionGets the id of the current activity.Gets the name of the current activity.return the Id of the current transitionreturn the Id of the parent activity instance currently executed by this executionGets the id of the parent of this execution.The business key for the process instance this execution is associated with.The process definition key for the process instance this execution is associated with.Return the process instance execution for this execution.Reference to the overall process instanceIn case this delegate execution is the process instance execution and this process instance was started by a call activity, this method returns the execution which executed the call activity in the super process instance.Return the id of the tenant this execution belongs to.boolean
Returns whether this execution has been canceled.void
resolveIncident
(String incidentId) Resolve and remove an incident with given idvoid
setProcessBusinessKey
(String businessKey) Configure a business key on the process instance this execution is associated with.void
setVariable
(String variableName, Object value, String activityId) Method to store variable in a specific scope identified by activity ID.Methods inherited from interface org.camunda.bpm.engine.delegate.BaseDelegateExecution
getBusinessKey, getEventName, getId
Methods inherited from interface org.camunda.bpm.engine.delegate.BpmnModelExecutionContext
getBpmnModelElementInstance, getBpmnModelInstance
Methods inherited from interface org.camunda.bpm.engine.delegate.ProcessEngineServicesAware
getProcessEngine, getProcessEngineServices
Methods inherited from interface org.camunda.bpm.engine.delegate.VariableScope
getVariable, getVariableLocal, getVariableLocalTyped, getVariableLocalTyped, getVariableNames, getVariableNamesLocal, getVariables, getVariableScopeKey, getVariablesLocal, getVariablesLocalTyped, getVariablesLocalTyped, getVariablesTyped, getVariablesTyped, getVariableTyped, getVariableTyped, hasVariable, hasVariableLocal, hasVariables, hasVariablesLocal, removeVariable, removeVariableLocal, removeVariables, removeVariables, removeVariablesLocal, removeVariablesLocal, setVariable, setVariableLocal, setVariables, setVariablesLocal
-
Method Details
-
getProcessInstanceId
String getProcessInstanceId()Reference to the overall process instance -
getProcessBusinessKey
String getProcessBusinessKey()The business key for the process instance this execution is associated with. -
setProcessBusinessKey
Configure a business key on the process instance this execution is associated with.- Parameters:
businessKey
- the new business key
-
getProcessDefinitionId
String getProcessDefinitionId()The process definition key for the process instance this execution is associated with. -
getParentId
String getParentId()Gets the id of the parent of this execution. If null, the execution represents a process-instance. -
getCurrentActivityId
String getCurrentActivityId()Gets the id of the current activity. -
getCurrentActivityName
String getCurrentActivityName()Gets the name of the current activity. -
getActivityInstanceId
String getActivityInstanceId()return the Id of the activity instance currently executed by this execution -
getParentActivityInstanceId
String getParentActivityInstanceId()return the Id of the parent activity instance currently executed by this execution -
getCurrentTransitionId
String getCurrentTransitionId()return the Id of the current transition -
getProcessInstance
DelegateExecution getProcessInstance()Return the process instance execution for this execution. In case this execution is the process instance execution the method returns itself. -
getSuperExecution
DelegateExecution getSuperExecution()In case this delegate execution is the process instance execution and this process instance was started by a call activity, this method returns the execution which executed the call activity in the super process instance.- Returns:
- the super execution or null.
-
isCanceled
boolean isCanceled()Returns whether this execution has been canceled. -
getTenantId
String getTenantId()Return the id of the tenant this execution belongs to. Can benull
if the execution belongs to no single tenant. -
setVariable
Method to store variable in a specific scope identified by activity ID.- Parameters:
variableName
- - name of the variablevalue
- - value of the variableactivityId
- - activity ID which is associated with destination execution, if not existing - exception will be thrown- Throws:
ProcessEngineException
- if scope with specified activity ID is not found
-
createIncident
Create an incident associated with this execution- Parameters:
incidentType
- the type of incidentconfiguration
-- Returns:
- a new incident
-
createIncident
Create an incident associated with this execution- Parameters:
incidentType
- the type of incidentconfiguration
-message
-- Returns:
- a new incident
-
resolveIncident
Resolve and remove an incident with given id- Parameters:
incidentId
-
-