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

Interface IFcForEachLoopDescriptors

All Superinterfaces:

IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<FcForEachLoopProps>

All Known Implementing Classes:

FcForEachLoopHandler

public interface IFcForEachLoopDescriptors
extends IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<FcForEachLoopProps>

The result descriptors for the data returned by the EWorkflowNodeType.FC_FOR_EACH_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	CURRENT_ATTR_ITEM	Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory).
static String	CURRENT_ATTR_KEY	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 IAttachmentValueDescriptor	getCurrentAttachmentValueDescriptor()	Creates the descriptor for the attachment or attachments that are created and made available to other actions while the node is being executed.
default IAttachmentValueDescriptor	getCurrentAttachmentValueDescriptor(FcForEachLoopProps props)	Same as getCurrentAttachmentValueDescriptor without data, but refined depending on the current node's configuration.
default IFileValueDescriptor	getCurrentFileValueDescriptor()	Creates the descriptor for the file or files that are created and made available to other actions while the node is being executed.
default IFileValueDescriptor	getCurrentFileValueDescriptor(FcForEachLoopProps props)	Same as getCurrentFileValueDescriptor without data, but refined depending on the current node's configuration.
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 IValueDescriptor<?,? extends IValueBuilder<?>>	getCurrentValueDescriptor(IValueDescriptorFactory factory, FcForEachLoopProps props)	Same as getCurrentValueDescriptor without data, but refined depending on the current node's configuration.
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different error types that may occur when the node is executed.
default IUnionValueDescriptor<String>	getErrorValueDescriptor(IValueDescriptorFactory f, FcForEachLoopProps props)	Same as getErrorValueDescriptor without data, but refined depending on the current node's configuration.
default IUnionValueDescriptor<String>	getSoftErrorValueDescriptor(IValueDescriptorFactory f)	The union descriptor for the different soft error types that may occur when the node is executed.
default IUnionValueDescriptor<String>	getSoftErrorValueDescriptor(IValueDescriptorFactory f, FcForEachLoopProps props)	Same as getSoftErrorValueDescriptor without data, but refined depending on the current node's configuration.
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, getFileValueDescriptor

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor

getAlwaysValueDescriptor, getAttachmentValueDescriptor, getFileValueDescriptor, getSuccessValueDescriptor

Field Detail

CURRENT_ATTR_INDEX

static final String CURRENT_ATTR_INDEX

Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory). The index of the current iteration, 0-based (0, 1, 2, ...)

See Also:

Constant Field Values

CURRENT_ATTR_ITEM

static final String CURRENT_ATTR_ITEM

Name of the corresponding property of the getCurrentValueDescriptor(IValueDescriptorFactory). The current item of the current iteration.

See Also:

Constant Field Values

CURRENT_ATTR_KEY

static final String CURRENT_ATTR_KEY

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). The total number of items that were iterated.

See Also:

Constant Field Values

Method Detail

getCurrentAttachmentValueDescriptor

default IAttachmentValueDescriptor getCurrentAttachmentValueDescriptor()

Description copied from interface: IExecutionResultDescriptor

Creates the descriptor for the attachment or attachments that are created and made available to other actions while the node is being executed. Should return null when the node provides no attachments.

Specified by:

getCurrentAttachmentValueDescriptor in interface IExecutionResultDescriptor

Returns:

The descriptor for the attachment or attachment made available while the node is being executed.

getCurrentAttachmentValueDescriptor

default IAttachmentValueDescriptor getCurrentAttachmentValueDescriptor(FcForEachLoopProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getCurrentAttachmentValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getCurrentAttachmentValueDescriptor in interface IRefinedExecutionResultDescriptor<FcForEachLoopProps>

Parameters:

props - Current properties model of the node.

Returns:

The descriptor for the attachment or attachments made available while the node is being executed. If null, the non-refined descriptor is used.

getCurrentFileValueDescriptor

default IFileValueDescriptor getCurrentFileValueDescriptor()

Description copied from interface: IExecutionResultDescriptor

Creates the descriptor for the file or files that are created and made available to other actions while the node is being executed. Should return null when the node provides no files.

Specified by:

getCurrentFileValueDescriptor in interface IExecutionResultDescriptor

Returns:

The descriptor for the file or files made available while the node is being executed.

getCurrentFileValueDescriptor

default IFileValueDescriptor getCurrentFileValueDescriptor(FcForEachLoopProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getCurrentFileValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getCurrentFileValueDescriptor in interface IRefinedExecutionResultDescriptor<FcForEachLoopProps>

Parameters:

props - Current properties model of the node.

Returns:

The descriptor for the file or files made available while the node is being executed. If null , the non-refined descriptor is used.

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.

getCurrentValueDescriptor

default IValueDescriptor<?,? extends IValueBuilder<?>> getCurrentValueDescriptor(IValueDescriptorFactory factory,
                                                                                       FcForEachLoopProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getCurrentValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getCurrentValueDescriptor in interface IRefinedExecutionResultDescriptor<FcForEachLoopProps>

Parameters:

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

props - Current properties model of the node.

Returns:

The descriptor for data published by the node while it is being executed. If null, the non-refined descriptor is used.

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory f)

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:

f - 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).

getErrorValueDescriptor

default IUnionValueDescriptor<String> getErrorValueDescriptor(IValueDescriptorFactory f,
                                                              FcForEachLoopProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getErrorValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getErrorValueDescriptor in interface IRefinedExecutionResultDescriptor<FcForEachLoopProps>

Parameters:

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

props - Current properties model of the node.

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). If null, the non-refined descriptor is used.

getSoftErrorValueDescriptor

default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory f)

Description copied from interface: IExecutionResultDescriptor

The union descriptor for the different soft 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("MISSING_UPLOAD", error) //
     .add("CLIENT_ERROR", error);
 

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

@implNote This interface provides a default implementation that returns an empty descriptor for backwards compatibility so as not to break existing implementation. However, all existing implementations are strongly advised to override and implement this method. The default implementation may be removed at some point.

Specified by:

getSoftErrorValueDescriptor in interface IExecutionResultDescriptor

Parameters:

f - 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 was successful, but contains one or more soft errors.

getSoftErrorValueDescriptor

default IUnionValueDescriptor<String> getSoftErrorValueDescriptor(IValueDescriptorFactory f,
                                                                  FcForEachLoopProps props)

Description copied from interface: IRefinedExecutionResultDescriptor

Same as getSoftErrorValueDescriptor without data, but refined depending on the current node's configuration.

Specified by:

getSoftErrorValueDescriptor in interface IRefinedExecutionResultDescriptor<FcForEachLoopProps>

Parameters:

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

props - Current properties model of the node.

Returns:

The value descriptor for the data that is made available to the workflow when the execution of the node was successful, but contains one or more soft errors. If null, the non-refined descriptor is used.

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.