Package de.xima.fc.interfaces.workflow.params

Interface INormalCompletionResultBuilder

All Superinterfaces:

org.apache.commons.lang3.builder.Builder<INormalCompletionResult>, ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>, ISuccessResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

public interface INormalCompletionResultBuilder
extends ISuccessResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Builder for the result returned by a node when it was executed successfully.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
INormalCompletionResultBuilder	always(IValueCreator alwaysValue)	Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception).
default INormalCompletionResultBuilder	always(Object alwaysValue)	Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception).
default INormalCompletionResultBuilder	file(IWorkflowFileValue fileValue)	Sets (replaces) the files made available by the node when it was executed.
default INormalCompletionResultBuilder	file(File... files)	Sets (replaces) the files made available by the node when it was executed, using the default file key.
default INormalCompletionResultBuilder	file(Iterable<File> files)	Sets (replaces) the files made available by the node when it was executed, using the default file key.
INormalCompletionResultBuilder	success(IValueCreator successValue)	Sets (replaces) the value returned by the node when it was executed successfully.
default INormalCompletionResultBuilder	success(Object value)	Sets (replaces) the value returned by the node when it was executed successfully.

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

build

Methods inherited from interface de.xima.fc.interfaces.workflow.params.ICompletionResultBuilder

attachment, attachment, attachment, file, file, file

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

softError, softError, softError, softError

Method Detail

always

INormalCompletionResultBuilder always(IValueCreator alwaysValue)

Description copied from interface: ICompletionResultBuilder

Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception). When this method is not called, the default value from the IExecutionResultDescriptor.getAlwaysValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

For example, when you wish to return a record with two properties:

 // Corresponds to the JSON object {"foo": "bar", "baz": 42}
 builder.success(b -> b.asRecord().property("foo", "bar").property("baz", 42);
 

Specified by:

always in interface ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

alwaysValue - Function that takes a value builder to create the value.

Returns:

This builder for chaining methods calls.

always

default INormalCompletionResultBuilder always(Object alwaysValue)

Description copied from interface: ICompletionResultBuilder

Sets (replaces) the value made available by the node regardless of whether it was executed successfully (or threw an exception). When this method is not called, the default value from the IExecutionResultDescriptor.getAlwaysValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

Specified by:

always in interface ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

alwaysValue - Value made available by the node when it was executed.

Returns:

This builder for chaining methods calls.

file

default INormalCompletionResultBuilder file(IWorkflowFileValue fileValue)

Description copied from interface: ICompletionResultBuilder

Sets (replaces) the files made available by the node when it was executed.

When this method is not called, the default value from the IExecutionResultDescriptor.getFileValueDescriptor() is used. When this method is called multiple times, only the value supplied by the last invocation is used.

Specified by:

file in interface ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

fileValue - File or files supplied by the node.

Returns:

This builder for chaining methods calls.

file

default INormalCompletionResultBuilder file(File... files)

Description copied from interface: ICompletionResultBuilder

Sets (replaces) the files made available by the node when it was executed, using the default file key. The contents of the files are guessed.

When this method is not called, the default value from the IExecutionResultDescriptor.getFileValueDescriptor() is used. When this method is called multiple times, only the value supplied by the last invocation is used.

Specified by:

file in interface ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

files - File or files supplied by the node.

Returns:

This builder for chaining methods calls.

file

default INormalCompletionResultBuilder file(Iterable<File> files)

Description copied from interface: ICompletionResultBuilder

Sets (replaces) the files made available by the node when it was executed, using the default file key. The contents of the files are guessed.

When this method is not called, the default value from the IExecutionResultDescriptor.getFileValueDescriptor() is used. When this method is called multiple times, only the value supplied by the last invocation is used.

Specified by:

file in interface ICompletionResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

files - File or files supplied by the node.

Returns:

This builder for chaining methods calls.

success

default INormalCompletionResultBuilder success(Object value)

Description copied from interface: ISuccessResultBuilder

Sets (replaces) the value returned by the node when it was executed successfully. This value is ignored unless the node was actually executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getSuccessValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

Specified by:

success in interface ISuccessResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

value - Value made available by the plugin when it was executed successfully.

Returns:

This builder for chaining methods calls.

success

INormalCompletionResultBuilder success(IValueCreator successValue)

Description copied from interface: ISuccessResultBuilder

Sets (replaces) the value returned by the node when it was executed successfully. This value is ignored unless the node was actually executed successfully. When this method is not called, the default value from the IExecutionResultDescriptor.getSuccessValueDescriptor(IValueDescriptorFactory) is used. When this method is called multiple times, only the value supplied by the last invocation is used.

For example, when you wish to return a record with two properties:

 // Corresponds to the JSON object {"foo": "bar", "baz": 42}
 builder.success(b -> b.asRecord().property("foo", "bar").property("baz", 42);
 

Specified by:

success in interface ISuccessResultBuilder<INormalCompletionResultBuilder,INormalCompletionResult>

Parameters:

successValue - Function that takes a value builder to create the value.

Returns:

This builder for chaining methods calls.