Package de.xima.fc.exceptions

Class NodeReturnedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.xima.fc.exceptions.AbstractXfcException

de.xima.fc.exceptions.WorkflowProcessingException

de.xima.fc.exceptions.AbstractAbruptCompletionException

de.xima.fc.exceptions.AbstractSuccessAbruptCompletionException

de.xima.fc.exceptions.NodeReturnedException

All Implemented Interfaces:

IXfcException, IBaseCompletionResult, IReturningCompletionResult, ISuccessResultData, Serializable

public final class NodeReturnedException
extends AbstractSuccessAbruptCompletionException
implements IReturningCompletionResult

Used by a node to indicate that the node completed abruptly by issuing a return statement.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeReturnedException.Builder	A simple builder for configuring a NodeReturnedException.

Constructor Summary

Constructors

Constructor	Description
NodeReturnedException(WorkflowNode node, Object alwaysValue, Object successValue, IWorkflowFileValue fileValue, List<NodeSoftErrorException> softErrors, String message)	Deprecated. Use builder(WorkflowNode).
NodeReturnedException(WorkflowNode node, Object alwaysValue, Object successValue, IWorkflowFileValue fileValue, List<NodeSoftErrorException> softErrors, String message, Throwable cause)	Deprecated. Use builder(WorkflowNode).
NodeReturnedException(WorkflowNode node, Object alwaysValue, Object successValue, IWorkflowFileValue fileValue, List<NodeSoftErrorException> softErrors, Throwable cause)	Deprecated. Use builder(WorkflowNode).

Method Summary

Modifier and Type	Method	Description
static NodeReturnedException.Builder	builder(WorkflowNode node)

Methods inherited from class de.xima.fc.exceptions.AbstractSuccessAbruptCompletionException

getSoftErrors, getSuccessValue

Methods inherited from class de.xima.fc.exceptions.AbstractAbruptCompletionException

getAlwaysValue, getAttachmentValue, getFileValue, getNode

Methods inherited from class de.xima.fc.exceptions.WorkflowProcessingException

getDefaultErrorCode, getDefaultMessageKey

Methods inherited from class de.xima.fc.exceptions.AbstractXfcException

getErrorCode, getExceptionData, getLocalizedMessage, getMessageKey, getMessageParams

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseCompletionResult

getAlwaysValue, getAttachmentValue, getFileValue, getNode

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.ISuccessResultData

getSoftErrors, getSuccessValue

Constructor Detail

NodeReturnedException

@Deprecated
public NodeReturnedException(WorkflowNode node,
                             Object alwaysValue,
                             Object successValue,
                             IWorkflowFileValue fileValue,
                             List<NodeSoftErrorException> softErrors,
                             String message)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.returningException().

Creates a new exception that should be thrown when a node wishes to return.

Parameters:

node - The node that did return.

alwaysValue - Data always provided by the node, regardless of how it completed.

successValue - Data provided by the node when successful.

fileValue - Files provided by the node.

softErrors - Soft errors that occurred during the node's execution.

message - Message why the note returned, usually empty.

NodeReturnedException

@Deprecated
public NodeReturnedException(WorkflowNode node,
                             Object alwaysValue,
                             Object successValue,
                             IWorkflowFileValue fileValue,
                             List<NodeSoftErrorException> softErrors,
                             String message,
                             Throwable cause)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.returningException().

Creates a new exception that should be thrown when a node wishes to return.

Parameters:

node - The node that did return.

alwaysValue - Data always provided by the node, regardless of how it completed.

successValue - Data provided by the node when successful.

fileValue - Files provided by the node.

softErrors - Soft errors that occurred during the node's execution.

message - Message why the note returned, usually empty.

cause - Cause that resulted in the node returning, usually null.

NodeReturnedException

@Deprecated
public NodeReturnedException(WorkflowNode node,
                             Object alwaysValue,
                             Object successValue,
                             IWorkflowFileValue fileValue,
                             List<NodeSoftErrorException> softErrors,
                             Throwable cause)

Deprecated.

Use builder(WorkflowNode). Ideally, do not create instances directly, prefer using INodeExecutionParams.returningException().

Creates a new exception that should be thrown when a node wishes to return.

Parameters:

node - The node that did return.

alwaysValue - Data always provided by the node, regardless of how it completed.

successValue - Data provided by the node when successful.

fileValue - Files provided by the node.

softErrors - Soft errors that occurred during the node's execution.

cause - Cause that resulted in the node returning, usually null.

Method Detail

builder

public static NodeReturnedException.Builder builder(WorkflowNode node)

Parameters:

node - The node that did finish execution.

Returns:

A new builder for a NodeReturnedException.

Since:

8.1.0