flux.agent

Interface AgentResult

All Known Implementing Classes:

AgentFileActionResult, AgentFileTriggerResult, AgentProcessActionResult

public interface AgentResult

Contains information about a trigger or action that is either currently running or has already finished running on an agent.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.util.Date	getBeginning() Returns the timestamp at which this process began executing.
long	getElapsedTime() Returns the number of milliseconds that this process executed.
java.util.Date	getEnding() Returns the timestamp at which this process began executing.
java.lang.String	getEngineName() Returns the name of the engine which assigned this process to the agent.
ErrorResultElement	getError() If this agent action ended with an error, returns the error that occurred when the execution of an Action was attempted.
java.lang.String	getFlowChartName() Returns the name of the flow chart which assigned this process to the agent.
AgentProcessCompletionState	getProcessCompletionState() Indicates how this process terminated: normally, with an error that occurred when the execution of the process was attempted, after timing out but still running to completion, after being destroyed due to a timeout, after being destroyed when a signal was received, or after being destroyed due to the process being interrupted.

Method Detail

getBeginning

java.util.Date getBeginning()

Returns the timestamp at which this process began executing.

Returns:

The timestamp at which this process began executing.

getElapsedTime

long getElapsedTime()

Returns the number of milliseconds that this process executed. Returns 0 if this process is not finished yet or did not run to completion.

Returns:

The number of milliseconds that this process executed. Returns 0 if this process is not finished yet or did not run to completion.

See Also:

AgentProcessCompletionState.NORMAL, AgentProcessCompletionState.TIMEOUT

getEnding

java.util.Date getEnding()

Returns the timestamp at which this process began executing. Returns null if this process is not finished yet or did not run to completion.

Returns:

The timestamp at which this process began executing. Returns null if this process is not finished yet or did not run to completion.

See Also:

AgentProcessCompletionState.NORMAL, AgentProcessCompletionState.TIMEOUT

getEngineName

java.lang.String getEngineName()

Returns the name of the engine which assigned this process to the agent.

Returns:

The name of the engine which assigned this process to the agent.

getError

ErrorResultElement getError()

If this agent action ended with an error, returns the error that occurred when the execution of an Action was attempted. Returns null if this action did not end with an error.

Returns:

If this agent action ended with an error, returns the error that occurred when the execution of an Action was attempted. Returns null if this action ended normally.

See Also:

AgentProcessCompletionState.ERROR

getFlowChartName

java.lang.String getFlowChartName()

Returns the name of the flow chart which assigned this process to the agent.

Returns:

The name of the flow chart which assigned this process to the agent.

getProcessCompletionState

AgentProcessCompletionState getProcessCompletionState()

Indicates how this process terminated: normally, with an error that occurred when the execution of the process was attempted, after timing out but still running to completion, after being destroyed due to a timeout, after being destroyed when a signal was received, or after being destroyed due to the process being interrupted.

Returns:

How this process terminated.