org.camunda.bpm.engine.runtime.InstantiationBuilder Maven / Gradle / Ivy
/*
* 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.ProcessEngineException;
/**
* @author Thorben Lindhauer
*/
public interface InstantiationBuilder> {
/**
* Submits the instruction:
*
* Start before the specified activity.
*
* In particular:
*
* - In the parent activity hierarchy, determine the closest existing ancestor activity instance
* - Instantiate all parent activities up to the ancestor's activity
* - Instantiate and execute the given activity (respects the asyncBefore
* attribute of the activity)
*
*
*
* @param activityId the activity to instantiate
* @throws ProcessEngineException if more than one possible ancestor activity instance exists
*/
T startBeforeActivity(String activityId);
/**
* Submits an instruction that behaves like {@link #startTransition(String)} and always instantiates
* the single outgoing sequence flow of the given activity. Does not consider asyncAfter.
*
* @param activityId the activity for which the outgoing flow should be executed
* @throws ProcessEngineException if the activity has 0 or more than 1 outgoing sequence flows
*/
T startAfterActivity(String activityId);
/**
* Submits the instruction:
*
* Start a sequence flow.
*
* In particular:
*
* - In the parent activity hierarchy, determine the closest existing ancestor activity instance
* - Instantiate all parent activities up to the ancestor's activity
* - Execute the given transition (does not consider sequence flow conditions)
*
*
*
* @param transitionId the sequence flow to execute
* @throws ProcessEngineException if more than one possible ancestor activity instance exists
*/
T startTransition(String transitionId);
}