org.camunda.bpm.engine.runtime.TransitionInstance 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;

/**
 * A transition instance represents an execution token that
 * has just completed a transition (sequence flow in BPMN) or is about
 * to take an outgoing transition. This happens before starting or after
 * leaving an activity. The execution token
 * is not actually executing the activity that this instance points to
 * which is why the corresponding activity instance does not exist.
 *
 * Transition instances are the result of
 * asynchronous continuations, asyncBefore or asyncAfter.
 *
 * @author Daniel Meyer
 * @author Thorben Lindhauer
 *
 */
public interface TransitionInstance extends ProcessElementInstance {

  /**
   * returns the id of the target activity
   *
   * @deprecated a transition instances represents a transition to or from
   *  an activity; use {@link #getActivityId()} instead.
   */
  @Deprecated
  String getTargetActivityId();

  /**
   * returns the id of the activity a transition is made from/to
   */
  String getActivityId();

  /** returns the id of of the execution that is
   * executing this transition instance */
  String getExecutionId();

  /**
   * returns the type of the activity a transition is made from/to.
   * Corresponds to BPMN element name in XML (e.g. 'userTask').
   * The type of the root activity instance (the one corresponding to the process instance)
   * is 'processDefinition'.
   */
  String getActivityType();

  /**
   * returns the name of the activity a transition is made from/to
   */
  String getActivityName();

  /** the ids of currently open incidents */
  String[] getIncidentIds();

  /** the list of currently open incidents */
  Incident[] getIncidents();

}