Package de.xima.fc.workflow.retval.node
Interface IFcMultipleConditionDescriptors
-
- All Superinterfaces:
IExecutionResultDescriptor
- All Known Implementing Classes:
FcMultipleConditionHandler
public interface IFcMultipleConditionDescriptors extends IExecutionResultDescriptor
The result descriptors for the data returned by theEWorkflowNodeType.FC_WHILE_LOOP
action.- Since:
- 8.2.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
Fields Modifier and Type Field Description static String
SUCCESS_ATTR_FULFILLED
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description 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, getCurrentValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor
-
-
-
-
Field Detail
-
SUCCESS_ATTR_FULFILLED
static final String SUCCESS_ATTR_FULFILLED
Name of the corresponding property of thegetSuccessValueDescriptor(IValueDescriptorFactory)
- See Also:
- Constant Field Values
-
-
Method Detail
-
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 codeCmnConst.Workflow.ERROR_CODE_GENERAL
is set automatically.- Specified by:
getErrorValueDescriptor
in interfaceIExecutionResultDescriptor
- Parameters:
factory
- Factory that may be used for creating the descriptor. You may also useValueDescriptorFactory.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 interfaceIExecutionResultDescriptor
- Parameters:
f
- Factory that may be used for creating the descriptor. Instead of the factory passed in to this method, you may also useValueDescriptorFactory.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.
-
-