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

/**
 * 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();

  /**
   * The id of the case definition of the case execution.
   */
  String getCaseDefinitionId();

  /**
   * The id of the activity associated with this case execution.
   */
  String getActivityId();

  /**
   * The name of the activity associated with this case execution.
   */
  String getActivityName();

  /**
   * The type of the activity associated with this case execution.
   */
  String getActivityType();

  /**
   * The description of the activity associated with this case execution.
   */
  String getActivityDescription();

  /**
   * The id of the parent of this case execution.
   */
  String getParentId();

  /**
   * Returns true if the case execution is required.
   */
  boolean isRequired();

  /**
   * Returns true if the case execution is available.
   */
  boolean isAvailable();

  /**
   * 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();

  /**
   * Returns true if the case execution is terminated.
   */
  boolean isTerminated();

  /**
   * The id of the tenant this case execution belongs to. Can be null
   * if the case execution belongs to no single tenant.
   */
  String getTenantId();

}