org.camunda.bpm.engine.history.HistoricProcessInstance 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.history;
import java.util.Date;
import org.camunda.bpm.engine.IdentityService;
import org.camunda.bpm.engine.runtime.ProcessInstance;
/**
* A single execution of a whole process definition that is stored permanently.
*
* @author Christian Stettler
* @author Askar Akhmerov
*/
public interface HistoricProcessInstance {
String STATE_ACTIVE = "ACTIVE";
String STATE_SUSPENDED = "SUSPENDED";
String STATE_COMPLETED = "COMPLETED";
String STATE_EXTERNALLY_TERMINATED = "EXTERNALLY_TERMINATED";
String STATE_INTERNALLY_TERMINATED = "INTERNALLY_TERMINATED";
/** The process instance id (== as the id for the runtime {@link ProcessInstance process instance}). */
String getId();
/** The user provided unique reference to this process instance. */
String getBusinessKey();
/** The process definition key reference. */
String getProcessDefinitionKey();
/** The process definition reference. */
String getProcessDefinitionId();
/** The process definition name. */
String getProcessDefinitionName();
/** The process definition version. */
Integer getProcessDefinitionVersion();
/** The time the process was started. */
Date getStartTime();
/** The time the process was ended. */
Date getEndTime();
/** The time the historic process instance will be removed. */
Date getRemovalTime();
/** The difference between {@link #getEndTime()} and {@link #getStartTime()} . */
Long getDurationInMillis();
/** Reference to the activity in which this process instance ended.
* Note that a process instance can have multiple end events, in this case it might not be deterministic
* which activity id will be referenced here. Use a {@link HistoricActivityInstanceQuery} instead to query
* for end events of the process instance (use the activityTYpe attribute)
* */
@Deprecated
String getEndActivityId();
/** The authenticated user that started this process instance.
* @see IdentityService#setAuthenticatedUserId(String) */
String getStartUserId();
/** The start activity. */
String getStartActivityId();
/** Obtains the reason for the process instance's deletion. */
String getDeleteReason();
/**
* The process instance id of a potential super process instance or null if no super process instance exists
*/
String getSuperProcessInstanceId();
/**
* The process instance id of the top-level (root) process instance or null if no root process instance exists
*/
String getRootProcessInstanceId();
/**
* The case instance id of a potential super case instance or null if no super case instance exists
*/
String getSuperCaseInstanceId();
/**
* The case instance id of a potential super case instance or null if no super case instance exists
*/
String getCaseInstanceId();
/**
* The id of the tenant this historic process instance belongs to. Can be null
* if the historic process instance belongs to no single tenant.
*/
String getTenantId();
/**
* Return current state of HistoricProcessInstance, following values are recognized during process engine operations:
*
* STATE_ACTIVE - running process instance
* STATE_SUSPENDED - suspended process instances
* STATE_COMPLETED - completed through normal end event
* STATE_EXTERNALLY_TERMINATED - terminated externally, for instance through REST API
* STATE_INTERNALLY_TERMINATED - terminated internally, for instance by terminating boundary event
*/
String getState();
}