flux
Interface ActionHistory

All Superinterfaces:

java.io.Serializable

public interface ActionHistory
extends java.io.Serializable

Contains historical timestamps for an action or trigger in a flow chart.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getActionName() Returns the identifying name of this action or trigger.
java.util.Date	getEnterTimestamp() Returns the timestamp of when this action or trigger was encountered in the execution flow.
java.util.Date	getExitTimestamp() The timestamp of when this action completed execution, or if a trigger, when the execute() method completed after the trigger fired.
java.lang.String	getNamespace() Returns the namespace of the flow chart containing this action or trigger.
long	getRuntime() Returns the difference between the start and exit timestamps in milliseconds.
java.util.Date	getStartTimestamp() Returns the timestamp of when the execute() method was called on this action, or if a trigger, when this trigger fired.
long	getWaitTime() Returns the difference in milliseconds between the enter and start timestamps.
boolean	isFinishedPrematurely() Indicates whether the flow chart was removed from the engine before this action finished.

Method Detail

getActionName

java.lang.String getActionName()

Returns the identifying name of this action or trigger.

Returns:

Returns the identifying name of this action or trigger.

getEnterTimestamp

java.util.Date getEnterTimestamp()

Returns the timestamp of when this action or trigger was encountered in the execution flow. The enter and start timestamps are identical for actions.

Returns:

The timestamp of when this action or trigger was encountered in the execution flow. Null is not returned from this method.

getExitTimestamp

java.util.Date getExitTimestamp()

The timestamp of when this action completed execution, or if a trigger, when the execute() method completed after the trigger fired.

Returns:

The timestamp of when this action completed execution, or if a trigger, when the execute() method completed after the trigger fired. Null is returned if this action has not completed execution, or if a trigger, when this trigger has not fired.

getNamespace

java.lang.String getNamespace()

Returns the namespace of the flow chart containing this action or trigger.

Returns:

The namespace of the flow chart containing this action or trigger.

getRuntime

long getRuntime()

Returns the difference between the start and exit timestamps in milliseconds.

Returns:

The difference between the start and exit timestamps in milliseconds. This method reuturns -1 if the action or trigger has not completed execution.

getStartTimestamp

java.util.Date getStartTimestamp()

Returns the timestamp of when the execute() method was called on this action, or if a trigger, when this trigger fired. The enter and start timestamps are identical for actions.

Returns:

The timestamp of when the execute() method was called on this action, or if a trigger, when this trigger fired. Null is returned if the trigger has not fired.

getWaitTime

long getWaitTime()

Returns the difference in milliseconds between the enter and start timestamps.

Returns:

The difference in milliseconds between the enter and start timestamps or -1 if this trigger has not fired. Zero is returned if this is an action.

isFinishedPrematurely

boolean isFinishedPrematurely()

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

Returns:

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