org.knime.core.node.workflow.execresult
Interface NodeContainerExecutionStatus

All Known Implementing Classes:

NodeContainerExecutionResult, SingleNodeContainerExecutionResult, WorkflowExecutionResult

public interface NodeContainerExecutionStatus

Status of a finished execution of a node. This information consists currently of a success flag and status information for all of the node's children (if it is a meta node).

For the standard execution (local thread execution), this is either FAILURE or SUCCESS. This interface becomes necessary (over a simple use of a success flag) to represent the execution status of a remotely executed meta-node.

Author:

Bernd Wiswedel, University of Konstanz

Field Summary

static NodeContainerExecutionStatus	FAILURE Represents a failed execution.
static NodeContainerExecutionStatus	SUCCESS Represents a successful execution.

Method Summary

NodeContainerExecutionStatus	getChildStatus(int idSuffix) Query the execution status for a child given its node id suffix.
boolean	isSuccess() Whether the execution was successful.

Field Detail

FAILURE

static final NodeContainerExecutionStatus FAILURE

Represents a failed execution.

SUCCESS

static final NodeContainerExecutionStatus SUCCESS

Represents a successful execution.

Method Detail

isSuccess

boolean isSuccess()

Whether the execution was successful. If the node represents a SingleNodeContainer, a successful execution brings the node into the NodeContainer.State.EXECUTED state, otherwise into NodeContainer.State.IDLE. If this object represents an execution status of a meta node, this method is typically ignored and the state is determined based on the internals of the meta node.

Returns:

the success status.

getChildStatus

NodeContainerExecutionStatus getChildStatus(int idSuffix)

Query the execution status for a child given its node id suffix. If the child is unknown, the implementation should return FAILURE.

Parameters:

idSuffix - The child id suffix

Returns:

The child execution status.