flux
Interface FlowChartRun

All Superinterfaces:

java.io.Serializable

public interface FlowChartRun
extends java.io.Serializable

Contains information about a flow chart run. A flow chart run is the time it takes for any execution flow to cross a pre-defined starting point in a flow chart until any execution flow crosses a pre-defined ending point in the same flow chart.

By default, the start of a run occurs when a flow chart first begins executing, and the end of a run occurs when a flow chart is completely finished and deleted from the engine.

In other words, by default, a run constitutes the lifetime of a flow chart.

However, for finer-grained reporting, set an explicit start and end of a run.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.util.Date	getEndOfRun() Returns the timestamp for the completion of this flow chart run.
java.lang.String	getFlowChartName() Returns the name of the flow chart with which this run is associated.
long	getRuntime() Returns the difference between the start-of-run and end-of-run timestamps in milliseconds.
java.util.Date	getStartOfRun() Returns the timestamp for the commencement of this flow chart run.
boolean	isFinishedPrematurely() Indicates whether this flow chart was removed from the engine before the flow chart run finished.

Method Detail

getEndOfRun

java.util.Date getEndOfRun()

Returns the timestamp for the completion of this flow chart run. If this flow chart run has not completed yet, returns null.

Returns:

The timestamp for the completion of this flow chart run. If this flow chart run has not completed yet, returns null.

getFlowChartName

java.lang.String getFlowChartName()

Returns the name of the flow chart with which this run is associated.

Returns:

The name of the flow chart with which this run is associated.

getRuntime

long getRuntime()

Returns the difference between the start-of-run and end-of-run timestamps in milliseconds.

Returns:

The difference between the start-of-run and end-of-run timestamps in milliseconds. This method returns -1 if the end-of-run has not been reached.

getStartOfRun

java.util.Date getStartOfRun()

Returns the timestamp for the commencement of this flow chart run. Does not return null.

Returns:

The timestamp for the commencement of this flow chart run. Does not return null.

isFinishedPrematurely

boolean isFinishedPrematurely()

Indicates whether this flow chart was removed from the engine before the flow chart run finished.

Returns:

Whether this flow chart was removed from the engine before the flow chart run finished.