org.camunda.bpm.engine.runtime.ConditionEvaluationBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of camunda-bpm-engine-api Show documentation
There is a newer version: 7.22.0
Show newest version
/*
 * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
 * under one or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information regarding copyright
 * ownership. Camunda licenses this file to you under the Apache License,
 * Version 2.0; you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.camunda.bpm.engine.runtime;

import java.util.List;
import java.util.Map;

/**
 * A fluent builder for defining conditional start event correlation
 *
 * @author Yana Vasileva
 */
public interface ConditionEvaluationBuilder {

  /**
   * 
   * 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 {@link #evaluateStartConditions()}.
   *
   * @param businessKey
   *          the businessKey to correlate on.
   * @return the builder
   */
  ConditionEvaluationBuilder processInstanceBusinessKey(String businessKey);

  /**
   * Correlate the condition such that a process definition with the given id is selected.
   * Is only supported for {@link #evaluateStartConditions()}.
   *
   * @param processDefinitionId the id of the process definition to correlate on.
   * @return the builder
   */
  ConditionEvaluationBuilder processDefinitionId(String processDefinitionId);

  /**
   * Pass a variable to the condition.
   *
   * Invoking this method multiple times allows passing multiple variables.
   *
   * @param variableName the name of the variable to set
   * @param variableValue the value of the variable to set
   * @return the builder
   */
  ConditionEvaluationBuilder setVariable(String variableName, Object variableValue);

  /**
   * Pass a variables to the condition.
   *
   * @param variables
   *          the map of variables
   * @return the builder
   */
  ConditionEvaluationBuilder setVariables(Map variables);

  /**
   * Specify a tenant to correlate a condition to. The condition can only be
   * correlated on process definitions which belongs to the given tenant.
   *
   * @param tenantId
   *          the id of the tenant
   * @return the builder
   */
  ConditionEvaluationBuilder tenantId(String tenantId);

  /**
   * Specify that the condition can only be correlated on process
   * definitions which belongs to no tenant.
   *
   * @return the builder
   */
  ConditionEvaluationBuilder withoutTenantId();

  /**
   *
   * @return the list of the newly created process instances
   */
  List evaluateStartConditions();

}