Package org.flowable.cmmn.engine.impl.runtime

Class InjectedPlanItemInstanceBuilderImpl

java.lang.Object
org.flowable.cmmn.engine.impl.runtime.InjectedPlanItemInstanceBuilderImpl
All Implemented Interfaces:
InjectedPlanItemInstanceBuilder
public class InjectedPlanItemInstanceBuilderImpl extends Object implements InjectedPlanItemInstanceBuilder
Implementation of the dynamically created and injected plan item into a running stage instance.
Author:
Micha Kiener

  • Field Details

    • commandExecutor

      protected final CommandExecutor commandExecutor

    • stagePlanItemInstanceId

      protected String stagePlanItemInstanceId

    • caseInstanceId

      protected String caseInstanceId

    • caseDefinitionId

      protected String caseDefinitionId

    • elementId

      protected String elementId

    • name

      protected String name

  • Constructor Details

    • InjectedPlanItemInstanceBuilderImpl

      public InjectedPlanItemInstanceBuilderImpl(CommandExecutor commandExecutor)

  • Method Details

    • name

      public InjectedPlanItemInstanceBuilder name(String name)
      Description copied from interface: InjectedPlanItemInstanceBuilder
      The explicit name for the new plan item to be created, if this is not set, the name of the referenced element is taken instead.
      Specified by:
      name in interface InjectedPlanItemInstanceBuilder
      Parameters:
      name - the explicit name to be used for the new plan item, which supersedes the one from the referenced plan item model
      Returns:
      the builder reference for method chaining

    • caseDefinitionId

      public InjectedPlanItemInstanceBuilder caseDefinitionId(String caseDefinitionId)
      Description copied from interface: InjectedPlanItemInstanceBuilder
      The id of the case definition from which the referenced plan item model should be taken as the model for the new plan item to be created dynamically.
      Specified by:
      caseDefinitionId in interface InjectedPlanItemInstanceBuilder
      Parameters:
      caseDefinitionId - the id of the case definition where the referenced plan item model is taken from
      Returns:
      the builder reference for method chaining

    • elementId

      public InjectedPlanItemInstanceBuilder elementId(String elementId)
      Description copied from interface: InjectedPlanItemInstanceBuilder
      The id of the referenced element within the case model to be used as the base line for the new dynamic plan item to be created.
      Specified by:
      elementId in interface InjectedPlanItemInstanceBuilder
      Parameters:
      elementId - the id of the referenced plan item element within the case model
      Returns:
      the builder reference for method chaining

    • createInStage

      public PlanItemInstance createInStage(String stagePlanItemInstanceId)
      Description copied from interface: InjectedPlanItemInstanceBuilder
      Create the newly setup plan item, add it to the parent running stage and plan it for activation and further processing in the case engine.
      Specified by:
      createInStage in interface InjectedPlanItemInstanceBuilder
      Parameters:
      stagePlanItemInstanceId - the id of the running stage plan item instance to inject a new plan item into
      Returns:
      the plan item instance dynamically be created

    • createInCase

      public PlanItemInstance createInCase(String caseInstanceId)
      Description copied from interface: InjectedPlanItemInstanceBuilder
      Create the newly setup plan item, add it to the parent running case instance and plan it for activation and further processing in the case engine.
      Specified by:
      createInCase in interface InjectedPlanItemInstanceBuilder
      Parameters:
      caseInstanceId - the id of the running case instance to inject a new plan item into
      Returns:
      the plan item instance dynamically be created

    • validateData

      protected void validateData()

    • injectInStage

      public boolean injectInStage()

    • injectInCase

      public boolean injectInCase()

    • getStagePlanItemInstanceId

      public String getStagePlanItemInstanceId()

    • getCaseInstanceId

      public String getCaseInstanceId()

    • getName

      public String getName()

    • getCaseDefinitionId

      public String getCaseDefinitionId()

    • getElementId

      public String getElementId()