INodeTransferredControlExceptionBuilder (formcycle: bom 8.2.0 API)

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<NodeTransferredControlException>, IAbruptCompletionExceptionBuilder<INodeTransferredControlExceptionBuilder,NodeTransferredControlException>, ICompletionResultBuilder<INodeTransferredControlExceptionBuilder,NodeTransferredControlException>, ISuccessResultBuilder<INodeTransferredControlExceptionBuilder,NodeTransferredControlException>
```
public interface INodeTransferredControlExceptionBuilder
extends ISuccessResultBuilder<INodeTransferredControlExceptionBuilder,NodeTransferredControlException>, IAbruptCompletionExceptionBuilder<INodeTransferredControlExceptionBuilder,NodeTransferredControlException>
```
Builder for the exception thrown by a node when it wishes to peform an abrupt local control transfer, e.g. by issuing a break or continue statement.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default INodeTransferredControlExceptionBuilder`	`targetNode(WorkflowNode targetNode)`	Sets the optional `target` of the loop node which is targeted by the abrupt loop completion.
`INodeTransferredControlExceptionBuilder`	`targetNode(NodeKey targetNode)`	Sets the optional `node key` of the loop node which is targeted by the abrupt loop completion.

Methods inherited from interface org.apache.commons.lang3.builder.Builder
build

Methods inherited from interface de.xima.fc.interfaces.workflow.params.IAbruptCompletionExceptionBuilder
cause, message

Methods inherited from interface de.xima.fc.interfaces.workflow.params.ICompletionResultBuilder
always, always, attachment, attachment, attachment, file, file, file, file, file, file

Methods inherited from interface de.xima.fc.interfaces.workflow.params.ISuccessResultBuilder
softError, softError, softError, softError, success, success

- Method Detail
  - targetNode
```
INodeTransferredControlExceptionBuilder targetNode(NodeKey targetNode)
```
    Sets the optional node key of the loop node which is targeted by the abrupt loop completion. When null, the closest node is targeted.
    
    Parameters:
    
    targetNode - Target of the loop interruption.
    
    Returns:
    
    This builder for chaining methods calls.
  - targetNode
```
default INodeTransferredControlExceptionBuilder targetNode(WorkflowNode targetNode)
```
    Sets the optional target of the loop node which is targeted by the abrupt loop completion. When null, the closest node is targeted.
    
    Parameters:
    
    targetNode - Target of the loop interruption.
    
    Returns:
    
    This builder for chaining methods calls.