org.camunda.bpm.engine.runtime.ProcessInstantiationBuilder 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 org.camunda.bpm.engine.AuthorizationException;
import org.camunda.bpm.engine.ProcessEngineException;
import org.camunda.bpm.engine.authorization.Permissions;
import org.camunda.bpm.engine.authorization.Resources;

/**
 * @author Thorben Lindhauer
 *
 */
public interface ProcessInstantiationBuilder
    extends ActivityInstantiationBuilder, InstantiationBuilder {

  /**
   * Specify the id of the tenant the process definition belongs to. Can only be
   * used when the definition is referenced by key and not by id.
   */
  ProcessInstantiationBuilder processDefinitionTenantId(String tenantId);

  /**
   * Specify that the process definition belongs to no tenant. Can only be
   * used when the definition is referenced by key and not by id.
   */
  ProcessInstantiationBuilder processDefinitionWithoutTenantId();

  /**
   * Set the business key for the process instance
   */
  ProcessInstantiationBuilder businessKey(String businessKey);

  /**
   * Associate a case instance with the process instance
   */
  ProcessInstantiationBuilder caseInstanceId(String caseInstanceId);

  /**
   * Start the process instance.
   *
   * @return the newly created process instance
   * @throws AuthorizationException
   *           if the user has no {@link Permissions#CREATE} permission on
   *           {@link Resources#PROCESS_INSTANCE} and no
   *           {@link Permissions#CREATE_INSTANCE} permission on
   *           {@link Resources#PROCESS_DEFINITION}.
   * @see also {@link #executeWithVariablesInReturn()}.
   */
  ProcessInstance execute();

  /**
   * Start the process instance.
   *
   * @param skipCustomListeners
   *          specifies whether custom listeners (task and execution) should be
   *          invoked when executing the instructions. Only supported for
   *          instructions.
   * @param skipIoMappings
   *          specifies whether input/output mappings for tasks should be
   *          invoked throughout the transaction when executing the
   *          instructions. Only supported for instructions.
   * @return the newly created process instance
   * @see also {@link #executeWithVariablesInReturn(boolean, boolean)}.
   */
  ProcessInstance execute(boolean skipCustomListeners, boolean skipIoMappings);

  /**
   * Start the process instance. If no instantiation instructions are set then
   * the instance start at the default start activity. Otherwise, all
   * instructions are executed in the order they are submitted. Custom execution
   * and task listeners, as well as task input output mappings are triggered.
   *
   * @return the newly created process instance with the latest variables
   *
   * @throws AuthorizationException
   *           if the user has no {@link Permissions#CREATE} permission on
   *           {@link Resources#PROCESS_INSTANCE} and no
   *           {@link Permissions#CREATE_INSTANCE} permission on
   *           {@link Resources#PROCESS_DEFINITION}.
   */
  ProcessInstanceWithVariables executeWithVariablesInReturn();

  /**
   * Start the process instance. If no instantiation instructions are set then
   * the instance start at the default start activity. Otherwise, all
   * instructions are executed in the order they are submitted.
   *
   * @param skipCustomListeners
   *          specifies whether custom listeners (task and execution) should be
   *          invoked when executing the instructions. Only supported for
   *          instructions.
   * @param skipIoMappings
   *          specifies whether input/output mappings for tasks should be
   *          invoked throughout the transaction when executing the
   *          instructions. Only supported for instructions.
   * @return the newly created process instance with the latest variables
   *
   * @throws AuthorizationException
   *           if the user has no {@link Permissions#CREATE} permission on
   *           {@link Resources#PROCESS_INSTANCE} and no
   *           {@link Permissions#CREATE_INSTANCE} permission on
   *           {@link Resources#PROCESS_DEFINITION}.
   *
   * @throws ProcessEngineException
   *           if {@code skipCustomListeners} or {@code skipIoMappings} is set
   *           to true but no instructions are submitted. Both options are not
   *           supported when the instance starts at the default start activity.
   *           Use {@link #execute()} instead.
   *
   */
  ProcessInstanceWithVariables executeWithVariablesInReturn(boolean skipCustomListeners, boolean skipIoMappings);
}