Package org.activiti.engine.delegate

Interface DelegateExecution

    • Method Detail

      • getId

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

        java.lang.String getProcessInstanceId()
        Reference to the overall process instance

      • getRootProcessInstanceId

        java.lang.String getRootProcessInstanceId()
        The 'root' process instance. When using call activity for example, the processInstance set will not always be the root. This method returns the topmost process instance.

      • getEventName

        java.lang.String getEventName()
        Will contain the event name in case this execution is passed in for an ExecutionListener.

      • setEventName

        void setEventName​(java.lang.String eventName)
        Sets the current event (typically when execution an ExecutionListener).

      • getProcessInstanceBusinessKey

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

      • 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.

      • getSuperExecutionId

        java.lang.String getSuperExecutionId()
        Gets the id of the calling execution. If not null, the execution is part of a subprocess.

      • getCurrentActivityId

        java.lang.String getCurrentActivityId()
        Gets the id of the current activity.

      • getTenantId

        java.lang.String getTenantId()
        Returns the tenant id, if any is set before on the process definition or process instance.

      • getCurrentFlowElement

        org.activiti.bpmn.model.FlowElement getCurrentFlowElement()
        The BPMN element where the execution currently is at.

      • setCurrentFlowElement

        void setCurrentFlowElement​(org.activiti.bpmn.model.FlowElement flowElement)
        Change the current BPMN element the execution is at.

      • getCurrentActivitiListener

        org.activiti.bpmn.model.ActivitiListener getCurrentActivitiListener()
        Returns the ActivitiListener instance matching an ExecutionListener if currently an execution listener is being execution. Returns null otherwise.

      • setCurrentActivitiListener

        void setCurrentActivitiListener​(org.activiti.bpmn.model.ActivitiListener currentActivitiListener)
        Called when an ExecutionListener is being executed.

      • getParent

        DelegateExecution getParent()
        returns the parent of this execution, or null if there no parent.

      • getExecutions

        java.util.List<? extends DelegateExecution> getExecutions()
        returns the list of execution of which this execution the parent of.

      • setActive

        void setActive​(boolean isActive)
        makes this execution active or inactive.

      • isActive

        boolean isActive()
        returns whether this execution is currently active.

      • isEnded

        boolean isEnded()
        returns whether this execution has ended or not.

      • setConcurrent

        void setConcurrent​(boolean isConcurrent)
        changes the concurrent indicator on this execution.

      • isConcurrent

        boolean isConcurrent()
        returns whether this execution is concurrent or not.

      • isProcessInstanceType

        boolean isProcessInstanceType()
        returns whether this execution is a process instance or not.

      • inactivate

        void inactivate()
        Inactivates this execution. This is useful for example in a join: the execution still exists, but it is not longer active.

      • isScope

        boolean isScope()
        Returns whether this execution is a scope.

      • setScope

        void setScope​(boolean isScope)
        Changes whether this execution is a scope or not.

      • isMultiInstanceRoot

        boolean isMultiInstanceRoot()
        Returns whather this execution is the root of a multi instance execution.

      • setMultiInstanceRoot

        void setMultiInstanceRoot​(boolean isMultiInstanceRoot)
        Changes whether this execution is a multi instance root or not.
        Parameters:
        isMultiInstanceRoot -