Package org.camunda.bpm.engine.runtime

Interface CaseExecution

  • All Known Subinterfaces:
    CaseInstance
    All Known Implementing Classes:
    CaseExecutionEntity
    public interface CaseExecution

    Represent a planned item in a case instance.

    Note that a CaseInstance also is an case execution.

    Author:
    Roman Smirnov

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityDescription()
      The description of the activity associated with this case execution.
      java.lang.String getActivityId()
      The id of the activity associated with this case execution.
      java.lang.String getActivityName()
      The name of the activity associated with this case execution.
      java.lang.String getActivityType()
      The type of the activity associated with this case execution.
      java.lang.String getCaseDefinitionId()
      The id of the case definition of the case execution.
      java.lang.String getCaseInstanceId()
      Id of the root of the case execution tree representing the case instance.
      java.lang.String getId()
      The unique identifier of the case execution.
      java.lang.String getParentId()
      The id of the parent of this case execution.
      java.lang.String getTenantId()
      The id of the tenant this case execution belongs to.
      boolean isActive()
      Returns true if the case execution is active.
      boolean isAvailable()
      Returns true if the case execution is available.
      boolean isDisabled()
      Returns true if the case execution is disabled.
      boolean isEnabled()
      Returns true if the case execution is enabled.
      boolean isRequired()
      Returns true if the case execution is required.
      boolean isTerminated()
      Returns true if the case execution is terminated.

    • Method Detail

      • getId

        java.lang.String getId()

        The unique identifier of the case execution.

      • getCaseInstanceId

        java.lang.String getCaseInstanceId()

        Id of the root of the case execution tree representing the case instance.

        It is the same as getId() if this case execution is the case instance.

      • getCaseDefinitionId

        java.lang.String getCaseDefinitionId()

        The id of the case definition of the case execution.

      • getActivityId

        java.lang.String getActivityId()

        The id of the activity associated with this case execution.

      • getActivityName

        java.lang.String getActivityName()

        The name of the activity associated with this case execution.

      • getActivityType

        java.lang.String getActivityType()

        The type of the activity associated with this case execution.

      • getActivityDescription

        java.lang.String getActivityDescription()

        The description of the activity associated with this case execution.

      • getParentId

        java.lang.String getParentId()

        The id of the parent of this case execution.

      • isRequired

        boolean isRequired()

        Returns true if the case execution is required.

      • isAvailable

        boolean isAvailable()

        Returns true if the case execution is available.

      • isActive

        boolean isActive()

        Returns true if the case execution is active.

      • isEnabled

        boolean isEnabled()

        Returns true if the case execution is enabled.

        Note: If this case execution is the case execution, it will return always false.

      • isDisabled

        boolean isDisabled()

        Returns true if the case execution is disabled.

        Note: If this case execution is the case instance, it will return always false.

      • isTerminated

        boolean isTerminated()

        Returns true if the case execution is terminated.

      • getTenantId

        java.lang.String getTenantId()
        The id of the tenant this case execution belongs to. Can be null if the case execution belongs to no single tenant.