Interface IBaseCompletionResult

All Superinterfaces:

Serializable

All Known Subinterfaces:

IControlTransferringCompletionResult, IExceptionalCompletionResult, INormalCompletionResult, IReturningCompletionResult, ISuccessResultData

All Known Implementing Classes:

AbstractAbruptCompletionException, AbstractSuccessAbruptCompletionException, NodeReturnedException, NodeThrewException, NodeTransferredControlException, NormalCompletionResult

public interface IBaseCompletionResult
extends Serializable

Represents any result of INodeHandler#execute, regardless how execution finished (normally or abruptly).

Since:

7.0.7

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Object	getAlwaysValue()
IWorkflowAttachmentValue	getAttachmentValue()
IWorkflowFileValue	getFileValue()
WorkflowNode	getNode()

Method Details

getAlwaysValue

Object getAlwaysValue()

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.

Since:

7.0.0 This super interface was introduced in 7.0.7, but the method itself existed in the subtypes since 7.0.0.

getAttachmentValue

IWorkflowAttachmentValue getAttachmentValue()

Returns:

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

Since:

8.1.0

getFileValue

IWorkflowFileValue getFileValue()

Returns:

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

Since:

7.0.0 This super interface was introduced in 7.0.7, but the method itself existed in the subtypes since 7.0.0.

getNode

WorkflowNode getNode()

Returns:

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

Since:

7.0.0 This super interface was introduced in 7.0.7, but the method itself existed in the subtypes since 7.0.0.