Package de.xima.fc.exceptions

Class AbstractAbruptCompletionException

java.lang.Object

java.lang.Throwable

java.lang.Exception

de.xima.fc.exceptions.AbstractXfcException

de.xima.fc.exceptions.WorkflowProcessingException

de.xima.fc.exceptions.AbstractAbruptCompletionException

All Implemented Interfaces:

IXfcException, IBaseCompletionResult, Serializable

Direct Known Subclasses:

NodeReturnedException, NodeThrewException

public abstract class AbstractAbruptCompletionException
extends WorkflowProcessingException
implements IBaseCompletionResult

Indicates that execution of a workflow node ended abruptly.

An abrupt completion always has an associated reason, which is one of the following:

• A return statement
• A throw statement, including exceptions thrown by the workflow runtime engine

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractAbruptCompletionException(WorkflowNode node, Object alwaysData, IWorkflowFileValue fileValue, String message)	Creates a new exception with the given data for a node that wants to end abruptly by throwing.
AbstractAbruptCompletionException(WorkflowNode node, Object alwaysData, IWorkflowFileValue fileValue, String message, Throwable cause)	Creates a new exception with the given data for a node that wants to end abruptly by throwing.
AbstractAbruptCompletionException(WorkflowNode node, Object alwaysData, IWorkflowFileValue fileValue, Throwable cause)	Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Method Summary

Modifier and Type	Method	Description
Object	getAlwaysValue()
IWorkflowFileValue	getFileValue()
WorkflowNode	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

Constructor Detail

AbstractAbruptCompletionException

public AbstractAbruptCompletionException(WorkflowNode node,
                                         Object alwaysData,
                                         IWorkflowFileValue fileValue,
                                         String message)

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - The The node that did return.

alwaysData - Data made available by the node irrespective of how it ends.

fileValue - List of files made available by the node.

message - Error message describing the error that occurred.

AbstractAbruptCompletionException

public AbstractAbruptCompletionException(WorkflowNode node,
                                         Object alwaysData,
                                         IWorkflowFileValue fileValue,
                                         String message,
                                         Throwable cause)

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - The The node that issued the exception.

alwaysData - Data made available by the node irrespective of how it ends.

fileValue - List of files made available by the node.

message - Error message describing the error that occurred.

cause - Cause that resulted in this exception.

AbstractAbruptCompletionException

public AbstractAbruptCompletionException(WorkflowNode node,
                                         Object alwaysData,
                                         IWorkflowFileValue fileValue,
                                         Throwable cause)

Creates a new exception with the given data for a node that wants to end abruptly by throwing.

Parameters:

node - The The node that did return.

alwaysData - Data made available by the node irrespective of how it ends.

fileValue - List of files made available by the node.

cause - Cause that resulted in this exception.

Method Detail

getAlwaysValue

public Object getAlwaysValue()

Specified by:

getAlwaysValue in interface IBaseCompletionResult

Returns:

The value that is always returned, whether or not the node completed normally. Must conform to the IExecutionResultDescriptor.getAlwaysValueDescriptor(IValueDescriptorFactory) IExecutionResultDescriptor#getAlwaysValueDescriptor.

getFileValue

public IWorkflowFileValue getFileValue()

Specified by:

getFileValue in interface IBaseCompletionResult

Returns:

The file returned by the node when executed normally. Must conform to the IExecutionResultDescriptor.getFileValueDescriptor().

getNode

public WorkflowNode getNode()

Specified by:

getNode in interface IBaseCompletionResult

Returns:

The node that created this result. May be null when no node is associated with this result.