Package de.xima.fc.workflow.processor.model

Class WorkflowNodeResult

java.lang.Object

de.xima.fc.workflow.processor.model.WorkflowNodeResult

All Implemented Interfaces:

IWorkflowNodeResult

public final class WorkflowNodeResult
extends Object
implements IWorkflowNodeResult

POJO implementation of IWorkflowNodeResult.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
static IWorkflowNodeResult	abruptly(AbstractAbruptCompletionException e)
AbstractAbruptCompletionException	getAbruptCompletionException()
ENodeCompletionType	getCompletionType()	Gets the type of how the node completed when it was executed.
INormalCompletionResult	getNormalCompletionResult()
static IWorkflowNodeResult	normal(INormalCompletionResult result)
static IWorkflowNodeResult	normalEmpty()
static IWorkflowNodeResult	returning(NodeReturnedException e)	*
static IWorkflowNodeResult	throwing(NodeThrewException e)
static IWorkflowNodeResult	transferringControl(NodeTransferredControlException e)	*

Methods inherited from class java.lang.Object

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

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

getAlwaysResultValue, getAttachmentValue, getErrorResultData, getFileValue, getNode, getReturningException, getSoftErrors, getSuccessResultData, getSuccessResultValue, getThrowingException, getTransferringControlException, isAbruptlyCompleted, isHasHardError, isHasSoftErrors, isHasSoftOrHardErrors, isNormallyCompleted, isWasSuccessful

Method Detail

getAbruptCompletionException

public AbstractAbruptCompletionException getAbruptCompletionException()

Specified by:

getAbruptCompletionException in interface IWorkflowNodeResult

Returns:

The exception that was thrown by the workflow node, or null when the node did not complete abruptly.

See Also:

IWorkflowNodeResult.getCompletionType()

getCompletionType

public ENodeCompletionType getCompletionType()

Description copied from interface: IWorkflowNodeResult

Gets the type of how the node completed when it was executed.

Specified by:

getCompletionType in interface IWorkflowNodeResult

Returns:

How the execution of the workflow node completed.

getNormalCompletionResult

public INormalCompletionResult getNormalCompletionResult()

Specified by:

getNormalCompletionResult in interface IWorkflowNodeResult

Returns:

The result returned by the workflow node upon execution, or null when the node did not complete normally.

See Also:

IWorkflowNodeResult.getCompletionType()

abruptly

public static IWorkflowNodeResult abruptly(AbstractAbruptCompletionException e)

Parameters:

e - Abrupt completion exception by the node.

Returns:

A new node result for an execution of a node that ended abruptly.

Throws:

ExecutionAbortedError - When the given exception is not one of the recognized types (which should never happen as the AbstractAbruptCompletionException is a sealed class).

Since:

8.1.0

normal

public static IWorkflowNodeResult normal(INormalCompletionResult result)

Parameters:

result - Result obtained after a node was executed successfully.

Returns:

A new node result for a successful execution.

normalEmpty

public static IWorkflowNodeResult normalEmpty()

Returns:

A new node result for a successful execution with no content.

returning

public static IWorkflowNodeResult returning(NodeReturnedException e)

*

Parameters:

e - Returning exception issued by the node.

Returns:

A new node result for a successful execution of a node that wishes to issue a return statement.

throwing

public static IWorkflowNodeResult throwing(NodeThrewException e)

Parameters:

e - Exception that occurred and cause the node's execution to fail.

Returns:

A new node result for a failed execution.

transferringControl

public static IWorkflowNodeResult transferringControl(NodeTransferredControlException e)

*

Parameters:

e - Loop continuing exception issued by the node.

Returns:

A new node result for a successful execution of a node that wishes to issue a continue statement.