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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of camunda-engine Show documentation

There is a newer version: 7.23.0-alpha2

/* Licensed under the Apache License, Version 2.0 (the "License");
 * 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;

/**
 * Represent a planned item in a case instance.
 *
 * Note that a {@link CaseInstance} also is an case execution.
 *
 * @author Roman Smirnov
 *
 */
public interface CaseExecution {

  /**
   * The unique identifier of the case execution.
   */
  String getId();

  /**
   * Id of the root of the case execution tree representing the case instance.
   *
   * It is the same as {@link #getId()} if this case execution is the case instance.
   */
  String getCaseInstanceId();

  /**
   * Returns true if the case execution is active.
   */
  boolean isActive();

  /**
   * Returns true if the case execution is enabled.
   *
   * Note: If this case execution is the case execution, it will
   * return always false.
   *
   */
  boolean isEnabled();

  /**
   * Returns true if the case execution is disabled.
   *
   * Note: If this case execution is the case instance, it will
   * return always false.
   */
  boolean isDisabled();


}