org.camunda.bpm.engine.delegate
Interface DelegateExecution

All Superinterfaces:
VariableScope
All Known Subinterfaces:
ActivityExecution, ExecutionListenerExecution, InterpretableExecution
All Known Implementing Classes:
ExecutionEntity, ExecutionImpl

public interface DelegateExecution
extends VariableScope

Execution used in JavaDelegates and ExecutionListeners.

Author:
Tom Baeyens

Method Summary
 String getActivityInstanceId()
          return the Id of the activity instance currently executed by this execution
 String getBusinessKey()
          Deprecated. use getProcessBusinessKey() to get the business key for the process associated with this execution, regardless whether or not this execution is a process-instance.
 String getCurrentActivityId()
          Gets the id of the current activity.
 String getCurrentActivityName()
          Gets the name of the current activity.
 String getCurrentTransitionId()
          return the Id of the current transition
 String getEventName()
          The event name in case this execution is passed in for an ExecutionListener
 String getId()
          Unique id of this path of execution that can be used as a handle to provide external signals back into the engine after wait states.
 String getParentActivityInstanceId()
          return the Id of the parent activity instance currently executed by this execution
 String getParentId()
          Gets the id of the parent of this execution.
 String getProcessBusinessKey()
          The business key for the process instance this execution is associated with.
 String getProcessDefinitionId()
          The process definition key for the process instance this execution is associated with.
 String getProcessInstanceId()
          Reference to the overall process instance
 
Methods inherited from interface org.camunda.bpm.engine.delegate.VariableScope
getVariable, getVariableLocal, getVariableNames, getVariableNamesLocal, getVariables, getVariablesLocal, hasVariable, hasVariableLocal, hasVariables, hasVariablesLocal, removeVariable, removeVariableLocal, removeVariables, removeVariables, removeVariablesLocal, removeVariablesLocal, setVariable, setVariableLocal, setVariables, setVariablesLocal
 

Method Detail

getId

String getId()
Unique id of this path of execution that can be used as a handle to provide external signals back into the engine after wait states.


getProcessInstanceId

String getProcessInstanceId()
Reference to the overall process instance


getEventName

String getEventName()
The event name in case this execution is passed in for an ExecutionListener


getBusinessKey

String getBusinessKey()
Deprecated. use getProcessBusinessKey() to get the business key for the process associated with this execution, regardless whether or not this execution is a process-instance.

The business key for this execution. Only returns a value if the delegate execution is a process instance.


getProcessBusinessKey

String getProcessBusinessKey()
The business key for the process instance this execution is associated with.


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



Copyright © 2014 camunda services GmbH. All Rights Reserved.