Package org.camunda.bpm.engine.runtime

Interface ConditionEvaluationBuilder

All Known Implementing Classes:
ConditionEvaluationBuilderImpl
public interface ConditionEvaluationBuilder

A fluent builder for defining conditional start event correlation

Author:
Yana Vasileva

  • Method Details

    • processInstanceBusinessKey

      ConditionEvaluationBuilder processInstanceBusinessKey(String businessKey)

      Correlate the condition such that the process instance has a business key with the given name. If the condition is correlated to a conditional start event then the given business key is set on the created process instance. Is only supported for evaluateStartConditions().

      Parameters:
      businessKey - the businessKey to correlate on.
      Returns:
      the builder

    • processDefinitionId

      ConditionEvaluationBuilder processDefinitionId(String processDefinitionId)

      Correlate the condition such that a process definition with the given id is selected. Is only supported for evaluateStartConditions().

      Parameters:
      processDefinitionId - the id of the process definition to correlate on.
      Returns:
      the builder

    • setVariable

      ConditionEvaluationBuilder setVariable(String variableName, Object variableValue)

      Pass a variable to the condition.

      Invoking this method multiple times allows passing multiple variables.

      Parameters:
      variableName - the name of the variable to set
      variableValue - the value of the variable to set
      Returns:
      the builder

    • setVariables

      ConditionEvaluationBuilder setVariables(Map<String,Object> variables)

      Pass a variables to the condition.

      Parameters:
      variables - the map of variables
      Returns:
      the builder

    • tenantId

      ConditionEvaluationBuilder tenantId(String tenantId)
      Specify a tenant to correlate a condition to. The condition can only be correlated on process definitions which belongs to the given tenant.
      Parameters:
      tenantId - the id of the tenant
      Returns:
      the builder

    • withoutTenantId

      ConditionEvaluationBuilder withoutTenantId()
      Specify that the condition can only be correlated on process definitions which belongs to no tenant.
      Returns:
      the builder

    • evaluateStartConditions

      List<ProcessInstance> evaluateStartConditions()
      Returns:
      the list of the newly created process instances