Package de.xima.fc.workflow.retval.node

Interface IFcDoUntilLoopDescriptors

All Superinterfaces:

IExecutionResultDescriptor

All Known Implementing Classes:

FcDoUntilLoopHandler

public interface IFcDoUntilLoopDescriptors
extends IExecutionResultDescriptor

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

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static String	CURRENT_ATTR_INDEX	Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory)
static 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 IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory factory)	The union descriptor 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 de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor

getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor

Field Detail

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 Detail

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.

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory factory)

Description copied from interface: IExecutionResultDescriptor

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

 factory.recordBuilder() //
     .requiredProperty("errorCode", factory.integer()) //
     .requiredProperty("errorMessage", factory.string()) //
     .requiredProperty("localizedMessage", factory.integer());
 return factory.add("CONNECT_TIMEOUT", error) //
     .add("READ_TIMEOUT", error);
 

The example above uses the same data type for each error, but you can return different data depending on the error type.

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:

getErrorValueDescriptor 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.