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 JavaDelegates and ExecutionListeners.

Author:

Tom Baeyens

Method Summary

Modifier and Type	Method	Description
Incident	createIncident(java.lang.String incidentType, java.lang.String configuration)	Create an incident associated with this execution
Incident	createIncident(java.lang.String incidentType, java.lang.String configuration, java.lang.String message)	Create an incident associated with this execution
java.lang.String	getActivityInstanceId()	return the Id of the activity instance currently executed by this execution
java.lang.String	getCurrentActivityId()	Gets the id of the current activity.
java.lang.String	getCurrentActivityName()	Gets the name of the current activity.
java.lang.String	getCurrentTransitionId()	return the Id of the current transition
java.lang.String	getParentActivityInstanceId()	return the Id of the parent activity instance currently executed by this execution
java.lang.String	getParentId()	Gets the id of the parent of this execution.
java.lang.String	getProcessBusinessKey()	The business key for the process instance this execution is associated with.
java.lang.String	getProcessDefinitionId()	The process definition key for the process instance this execution is associated with.
DelegateExecution	getProcessInstance()	Return the process instance execution for this execution.
java.lang.String	getProcessInstanceId()	Reference to the overall process instance
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.
java.lang.String	getTenantId()	Return the id of the tenant this execution belongs to.
boolean	isCanceled()	Returns whether this execution has been canceled.
void	resolveIncident(java.lang.String incidentId)	Resolve and remove an incident with given id
void	setProcessBusinessKey(java.lang.String businessKey)	Configure a business key on the process instance this execution is associated with.
void	setVariable(java.lang.String variableName, java.lang.Object value, java.lang.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 Detail

getProcessInstanceId

java.lang.String getProcessInstanceId()

Reference to the overall process instance

getProcessBusinessKey

java.lang.String getProcessBusinessKey()

The business key for the process instance this execution is associated with.

setProcessBusinessKey

void setProcessBusinessKey(java.lang.String businessKey)

Configure a business key on the process instance this execution is associated with.

Parameters:

businessKey - the new business key

getProcessDefinitionId

java.lang.String getProcessDefinitionId()

The process definition key for the process instance this execution is associated with.

getParentId

java.lang.String getParentId()

Gets the id of the parent of this execution. If null, the execution represents a process-instance.

getCurrentActivityId

java.lang.String getCurrentActivityId()

Gets the id of the current activity.

getCurrentActivityName

java.lang.String getCurrentActivityName()

Gets the name of the current activity.

getActivityInstanceId

java.lang.String getActivityInstanceId()

return the Id of the activity instance currently executed by this execution

getParentActivityInstanceId

java.lang.String getParentActivityInstanceId()

return the Id of the parent activity instance currently executed by this execution

getCurrentTransitionId

java.lang.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

java.lang.String getTenantId()

Return the id of the tenant this execution belongs to. Can be null if the execution belongs to no single tenant.

setVariable

void setVariable(java.lang.String variableName,
                 java.lang.Object value,
                 java.lang.String activityId)

Method to store variable in a specific scope identified by activity ID.

Parameters:

variableName - - name of the variable

value - - value of the variable

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

Incident createIncident(java.lang.String incidentType,
                        java.lang.String configuration)

Create an incident associated with this execution

Parameters:

incidentType - the type of incident

configuration -

Returns:

a new incident

createIncident

Incident createIncident(java.lang.String incidentType,
                        java.lang.String configuration,
                        java.lang.String message)

Create an incident associated with this execution

Parameters:

incidentType - the type of incident

configuration -

message -

Returns:

a new incident

resolveIncident

void resolveIncident(java.lang.String incidentId)

Resolve and remove an incident with given id

Parameters:

incidentId -