All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.flowable.engine.runtime.ActivityInstance Maven / Gradle / Ivy

There is a newer version: 7.0.1
Show newest version
/*
 * 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.flowable.engine.runtime;

import java.util.Date;

import org.flowable.common.engine.api.history.HistoricData;

/**
 * Represents one execution of an activity in the currently running process. It's stored for statistics, audit and other business intelligence purposes.
 * 
 * @author martin.grofcik
 */
public interface ActivityInstance extends HistoricData {

    /** The unique identifier of this historic activity instance. */
    String getId();

    /** The unique identifier of the activity in the process */
    String getActivityId();

    /** The display name for the activity */
    String getActivityName();

    /** The XML tag of the activity as in the process file */
    String getActivityType();

    /** Process definition reference */
    String getProcessDefinitionId();

    /** Process instance reference */
    String getProcessInstanceId();

    /** Execution reference */
    String getExecutionId();

    /** The corresponding task in case of task activity */
    String getTaskId();

    /** The called process instance in case of call activity */
    String getCalledProcessInstanceId();

    /** Assignee in case of user task activity */
    String getAssignee();

    /** Time when the activity instance started */
    Date getStartTime();

    /** Time when the activity instance ended */
    Date getEndTime();

    /** Difference between {@link #getEndTime()} and {@link #getStartTime()}. */
    Long getDurationInMillis();
    
    /** Get transaction order value */
    Integer getTransactionOrder();

    /** Returns the delete reason for this activity, if any was set (if completed normally, no delete reason is set) */
    String getDeleteReason();

    /** Returns the tenant identifier for the historic activity */
    String getTenantId();
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy