Interface IFcWhileLoopDescriptors

All Superinterfaces:

IExecutionResultDescriptor

All Known Implementing Classes:

FcWhileLoopHandler

public interface IFcWhileLoopDescriptors
extends IExecutionResultDescriptor

The result descriptors for the data returned by the EWorkflowNodeType.FC_WHILE_LOOP action.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CURRENT_ATTR_INDEX	Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory)
static final String	SUCCESS_ATTR_COUNT	Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

Method Summary

Modifier and Type	Method	Description
default IValueDescriptor<?, ? extends IValueBuilder<?>>	getCurrentValueDescriptor(IValueDescriptorFactory f)	Creates the value descriptor for the data that is made available to the workflow while the node is being executed.
default Map<String, IValueDescriptor<?,?>>	getErrorValueDescriptors(IValueDescriptorFactory factory)	The descriptors for the different error types that may occur when the node is executed.
default IValueDescriptor<?, ? extends IValueBuilder<?>>	getSuccessValueDescriptor(IValueDescriptorFactory f)	Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.

Methods inherited from interface IExecutionResultDescriptor

getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors

Field Details

CURRENT_ATTR_INDEX

static final String CURRENT_ATTR_INDEX

Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory)

See Also:

• Constant Field Values

SUCCESS_ATTR_COUNT

static final String SUCCESS_ATTR_COUNT

Name of the corresponding property of the getSuccessValueDescriptor(IValueDescriptorFactory)

See Also:

• Constant Field Values

Method Details

getCurrentValueDescriptor

default IValueDescriptor<?, ? extends IValueBuilder<?>> getCurrentValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

Creates the value descriptor for the data that is made available to the workflow while the node is being executed.

Specified by:

getCurrentValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The descriptor for data published by the node while it is being executed.

getErrorValueDescriptors

default Map<String, IValueDescriptor<?,?>> getErrorValueDescriptors(IValueDescriptorFactory factory)

Description copied from interface: IExecutionResultDescriptor

The descriptors for the different error types that may occur when the node is executed. Each discriminator of the union represents an error or exception type.

var connectTimeoutError = factory.recordBuilder().requiredProperty("connectTimeoutMs", factory.integer());
var readTimeoutError = factory.recordBuilder().requiredProperty("readTimeoutMs", factory.integer());
return Map.of("CONNECT_TIMEOUT", connectTimeoutError, "READ_TIMEOUT", readTimeoutError);

The example above uses a different set of data each type of error.

Note that you do not have to include a general error code. When the execute method of a node handler throws an unhandled (runtime) exception, the error code CmnConst.Workflow.ERROR_CODE_GENERAL is set automatically.

Specified by:

getErrorValueDescriptors in interface IExecutionResultDescriptor

Parameters:

factory - Factory that may be used for creating the descriptor. You may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node failed (such as by throwing an exception).

getSuccessValueDescriptor

default IValueDescriptor<?, ? extends IValueBuilder<?>> getSuccessValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

Creates the value descriptor for the data that is made available to the workflow when the node was executed successfully.

Specified by:

getSuccessValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also use ValueDescriptorFactory.getInstance() if you wish to cache the descriptor in a static or instance field.

Returns:

The data provided by the node after having been executed successfully.