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:

AbstractSuccessAbruptCompletionException, 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, see NodeReturnedException
• A throw statement, including exceptions thrown by the workflow runtime engine, see NodeThrewException
• A control transfer statement, such as a break or continue statement, often used by loops, see NodeTransferredControlException

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractAbruptCompletionException.Builder<Self extends AbstractAbruptCompletionException.Builder>	A simple builder for an AbstractAbruptCompletionException

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAbruptCompletionException(AbstractAbruptCompletionException.Builder<?> builder)	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()
IWorkflowAttachmentValue	getAttachmentValue()
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

protected AbstractAbruptCompletionException(AbstractAbruptCompletionException.Builder<?> builder)

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

Parameters:

builder - Builder with the data to set.

Since:

8.1.0

Method Detail

getAlwaysValue

public Object getAlwaysValue()

Specified by:

getAlwaysValue in interface IBaseCompletionResult

Returns:

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

getAttachmentValue

public IWorkflowAttachmentValue getAttachmentValue()

Specified by:

getAttachmentValue in interface IBaseCompletionResult

Returns:

The attachment or attachments returned by the node when executed. Must conform to the IExecutionResultDescriptor.getAttachmentValueDescriptor().

getFileValue

public IWorkflowFileValue getFileValue()

Specified by:

getFileValue in interface IBaseCompletionResult

Returns:

The file returned by the node when executed. 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.