flux
Interface FlowChartElement

All Superinterfaces:

AbstractFlowContextStatus, FlowContextStatus, java.io.Serializable

public interface FlowChartElement
extends FlowContextStatus

Contains the fundamental portions of a running flow context within an executing flow chart.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getActionDescription() Returns the description for the currently executing action or trigger on this running flow context.
java.lang.String	getActionType() Returns the bean display name for the currently executing trigger or action on this running flow context.
long	getAverageRuntime() Returns the average runtime in milliseconds for this flow chart's run.
java.util.Date	getDeadline() Returns the deadline for this flow chart.
java.lang.String	getEngineName() Returns the name of the engine that is running this flow context.
long	getExecutionTime() Returns the epoch timestamp for the commencement of this action.
FileTransferInfo	getFileTransferInfo() If the current action is a file action, returns details about a file being transferred by this flow chart such as bytes transferred and total number of bytes.
long	getFlowChartCreation() Returns the epoch timestamp when this flowchart was exported to the engine.
java.lang.String	getFlowChartDescription() Returns the description for this flow chart.
java.lang.String	getFlowChartName() Returns the name of this flow chart.
int	getFlowContextCount() Returns the number of flow contexts in this flow chart.
java.util.Date	getStartOfRun() Returns the timestamp for the commencement of this flow chart run.
java.lang.String	getStatus() Returns the status message for this flow context, which is an optional natural language description that describes the state of this flow context within the scope of its enveloping flow chart.
boolean	isDeadlineExceeded() Returns whether the flow chart, or flow chart run, exceeded its deadline.
boolean	isSkippable() Returns whether the action that caused the flow chart to enter the failed state can be skipped.
boolean	isWithinDeadlineWindow() Returns whether the flow chart or denoted flow chart run is within its deadline window.

Methods inherited from interface flux.FlowContextStatus

getFailureErrorResult

Methods inherited from interface flux.AbstractFlowContextStatus

getEffectivePriority, getId, getName, getPriority, getSubState, getSuperState

Method Detail

getActionDescription

java.lang.String getActionDescription()

Returns the description for the currently executing action or trigger on this running flow context.

Returns:

The description for the currently executing action or trigger on this running flow context.

See Also:

Action.getDescription()

getActionType

java.lang.String getActionType()

Returns the bean display name for the currently executing trigger or action on this running flow context. For example, the action type for a:

• TimerTrigger is "Timer Trigger"
• ConsoleAction is "Console Action"

Returns:

The bean display name for the currently executing trigger or action on this running flow context.

getAverageRuntime

long getAverageRuntime()

Returns the average runtime in milliseconds for this flow chart's run. A flow chart run defaults to the start and end of a flow chart. The start-of-run and end-of-run flags can be set on actions to explicitly define the start and end points of a run.

Returns:

The average runtime in milliseconds for this flow charts run or -1 if run averages are not available for this flow chart.

getDeadline

java.util.Date getDeadline()

Returns the deadline for this flow chart.

The deadline specifies when this flow chart or denoted flow chart run should finish execution. A DeadlineExceededEvent is published to the audit trail if this flow chart does not complete execution by the deadline.

The display of flow charts in the Flux Operations Console indicates the deadline status of flow charts by highlighting flow charts in appropriate colors.

Returns:

The deadline for this flow chart or null if a deadline is not set.

See Also:

FlowChart.setDeadline(java.util.Date)

getEngineName

java.lang.String getEngineName()

Returns the name of the engine that is running this flow context.

Returns:

The name of the engine that is running this flow context.

See Also:

Configuration.ID_NAME

getFileTransferInfo

FileTransferInfo getFileTransferInfo()

If the current action is a file action, returns details about a file being transferred by this flow chart such as bytes transferred and total number of bytes. Otherwise, returns null.

Returns:

If the current action is a file action, details about a file being transferred by this flow chart such as bytes transferred and total number of bytes. Otherwise, returns null.

getFlowChartDescription

java.lang.String getFlowChartDescription()

Returns the description for this flow chart.

Returns:

The description for this flow chart.

See Also:

FlowChart.getDescription()

getFlowChartName

java.lang.String getFlowChartName()

Returns the name of this flow chart.

Returns:

The name of this flow chart.

getFlowContextCount

int getFlowContextCount()

Returns the number of flow contexts in this flow chart.

Returns:

The number of flow contexts in this flow chart.

getStartOfRun

java.util.Date getStartOfRun()

Returns the timestamp for the commencement of this flow chart run.

Returns:

The timestamp for the commencement of this flow chart run. Returns null if the flow chart run has not started.

getExecutionTime

long getExecutionTime()

Returns the epoch timestamp for the commencement of this action.

Returns:

The epoch timestamp for the commencement of this action.

getFlowChartCreation

long getFlowChartCreation()

Returns the epoch timestamp when this flowchart was exported to the engine.

Returns:

The epoch timestamp when this flowchart was exported to the engine.

getStatus

java.lang.String getStatus()

Returns the status message for this flow context, which is an optional natural language description that describes the state of this flow context within the scope of its enveloping flow chart.

Returns:

The status message for this flow context.

See Also:

FlowContext.getStatus()

isDeadlineExceeded

boolean isDeadlineExceeded()

Returns whether the flow chart, or flow chart run, exceeded its deadline.

Returns:

Whether the flow chart, or flow chart run, exceeded its deadline.

See Also:

getDeadline()

isSkippable

boolean isSkippable()

Returns whether the action that caused the flow chart to enter the failed state can be skipped. Always returns false if the flow chart is not in the failed state.

Returns:

Whether the action that caused the flow chart to enter the failed state can be skipped.

See Also:

Action.isSkippable()

isWithinDeadlineWindow

boolean isWithinDeadlineWindow()

Returns whether the flow chart or denoted flow chart run is within its deadline window. A deadline window is a warning period that comes immediately before the actual deadline.

The display of flow charts in the Flux Operations Console indicates the deadline window status of flow charts by highlighting flow charts in appropriate colors.

Returns:

Whether the flow chart is within its deadline window.

See Also:

getDeadline()