flux.agent
Class AgentFileTriggerResult

java.lang.Object
  flux.file.FileTrigger.FileTriggerResult
      flux.agent.AgentFileTriggerResult

All Implemented Interfaces:

AgentResult, PersistentVariableListener, java.io.Serializable, java.lang.Cloneable

public class AgentFileTriggerResult
extends FileTrigger.FileTriggerResult
implements AgentResult

The result from a file trigger that ran on an agent. The result contains matching files and directories from a concrete file trigger.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

See Also:

Serialized Form

Field Summary

Fields inherited from class flux.file.FileTrigger.FileTriggerResult

fileinfo_matches, filename_matches, url_object_matches, url_string_matches

Method Summary

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.util.List<FileInfo>	getFileInfoMatches() Returns details about files against which the file trigger matched using its file criteria.
java.util.List<java.lang.String>	getFilenameMatches() Returns simple, base file names, without path information, of files against which the file trigger matched using its file criteria.
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.
java.util.List<java.lang.String>	getUrlStringMatches() Returns URLs of files and directories against which the file trigger matched using its file criteria.

Methods inherited from class flux.file.FileTrigger.FileTriggerResult

clone, createdVariable, persistingVariable

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getBeginning

public java.util.Date getBeginning()

Description copied from interface: AgentResult

Returns the timestamp at which this process began executing.

Specified by:

getBeginning in interface AgentResult

Returns:

The timestamp at which this process began executing.

getElapsedTime

public long getElapsedTime()

Description copied from interface: AgentResult

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

Specified by:

getElapsedTime in interface AgentResult

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

public java.util.Date getEnding()

Description copied from interface: AgentResult

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

Specified by:

getEnding in interface AgentResult

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

public java.lang.String getEngineName()

Description copied from interface: AgentResult

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

Specified by:

getEngineName in interface AgentResult

Returns:

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

getError

public ErrorResultElement getError()

Description copied from interface: AgentResult

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.

Specified by:

getError in interface AgentResult

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

getFileInfoMatches

public java.util.List<FileInfo> getFileInfoMatches()

Returns details about files against which the file trigger matched using its file criteria. Details include file size, last modified date, and file permissions.

getFilenameMatches

public java.util.List<java.lang.String> getFilenameMatches()

Returns simple, base file names, without path information, of files against which the file trigger matched using its file criteria.

getFlowChartName

public java.lang.String getFlowChartName()

Description copied from interface: AgentResult

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

Specified by:

getFlowChartName in interface AgentResult

Returns:

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

getProcessCompletionState

public AgentProcessCompletionState getProcessCompletionState()

Description copied from interface: AgentResult

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.

Specified by:

getProcessCompletionState in interface AgentResult

Returns:

How this process terminated.

getUrlStringMatches

public java.util.List<java.lang.String> getUrlStringMatches()

Returns URLs of files and directories against which the file trigger matched using its file criteria.