Package org.flowable.cmmn.engine.impl.reactivation

Class CaseReactivationBuilderImpl

java.lang.Object
org.flowable.cmmn.engine.impl.reactivation.CaseReactivationBuilderImpl
All Implemented Interfaces:
CaseReactivationBuilder
public class CaseReactivationBuilderImpl extends Object implements CaseReactivationBuilder
The case reactivation builder implementation storing reactivation specific information and executing the reactivation command to reactivate a historical case instance.
Author:
Micha Kiener

  • Field Details

    • commandExecutor

      protected final CommandExecutor commandExecutor

    • caseInstanceId

      protected final String caseInstanceId

    • terminatedPlanItemDefinitionIds

      protected List<String> terminatedPlanItemDefinitionIds

    • variables

      protected Map<String,Object> variables

    • transientVariables

      protected Map<String,Object> transientVariables

  • Constructor Details

    • CaseReactivationBuilderImpl

      public CaseReactivationBuilderImpl(CommandExecutor commandExecutor, String caseInstanceId)

  • Method Details

    • getCaseInstanceId

      public String getCaseInstanceId()

    • getTerminatedPlanItemDefinitionIds

      public List<String> getTerminatedPlanItemDefinitionIds()

    • hasVariables

      public boolean hasVariables()

    • getVariables

      public Map<String,Object> getVariables()

    • hasTransientVariables

      public boolean hasTransientVariables()

    • getTransientVariables

      public Map<String,Object> getTransientVariables()

    • addTerminatedPlanItemInstanceForPlanItemDefinition

      public CaseReactivationBuilder addTerminatedPlanItemInstanceForPlanItemDefinition(String planItemDefinitionId)
      Description copied from interface: CaseReactivationBuilder
      Adds a plan item instance for a new plan item definition. This is mainly needed when no reactivation listener was present in the old case definition id.
      Specified by:
      addTerminatedPlanItemInstanceForPlanItemDefinition in interface CaseReactivationBuilder
      Parameters:
      planItemDefinitionId - the plan item definition id for which a new plan item instance will be created in available state
      Returns:
      the builder for method chaining

    • variable

      public CaseReactivationBuilder variable(String name, Object value)
      Description copied from interface: CaseReactivationBuilder
      Adds a variable to be added to the case before triggering the reactivation event.
      Specified by:
      variable in interface CaseReactivationBuilder
      Parameters:
      name - the name of the variable to be added
      value - the value of the variable to be added
      Returns:
      the builder for method chaining

    • variables

      public CaseReactivationBuilder variables(Map<String,Object> variables)
      Description copied from interface: CaseReactivationBuilder
      Adds the map of variables to the case before triggering the reactivation event.
      Specified by:
      variables in interface CaseReactivationBuilder
      Parameters:
      variables - the map of variables to be added to the case
      Returns:
      the builder for method chaining

    • transientVariable

      public CaseReactivationBuilder transientVariable(String name, Object value)
      Description copied from interface: CaseReactivationBuilder
      Adds a transient variable to the case before triggering the reactivation event which is available only during that first transaction.
      Specified by:
      transientVariable in interface CaseReactivationBuilder
      Parameters:
      name - the name of the variable to be added
      value - the value of the variable to be added
      Returns:
      the builder for method chaining

    • transientVariables

      public CaseReactivationBuilder transientVariables(Map<String,Object> variables)
      Description copied from interface: CaseReactivationBuilder
      Adds a map of transient variables to the case before triggering the reactivation event which are available only during that first transaction.
      Specified by:
      transientVariables in interface CaseReactivationBuilder
      Parameters:
      variables - the map of variables to be added to the case
      Returns:
      the builder for method chaining

    • reactivate

      public CaseInstance reactivate()
      Description copied from interface: CaseReactivationBuilder
      After having entered all necessary information for the reactivation, this method actually triggers the reactivation and returns the reactivated case instance from the runtime.
      Specified by:
      reactivate in interface CaseReactivationBuilder
      Returns:
      the reactivated case instance copied back to the runtime