Interface IResultlessNode<TData>
-
- Type Parameters:
TData
- Type of the node's properties model.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,INodeHandler<TData>
,IRefinedExecutionResultDescriptor<TData>
,IResourceBundleLocator
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Implementing Classes:
FcBreakHandler
,FcContinueHandler
,FcDeleteFormRecordHandler
,FcEmptyHandler
,FcExperimentHandler
,FcReturnHandler
,FcSequenceHandler
,FcSwitchCaseHandler
,FcSwitchDefaultHandler
,FcSwitchHandler
public interface IResultlessNode<TData> extends INodeHandler<TData>, IExecutionResultDescriptor
Mixin for nodes that neither return a result nor do throw an error.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
-
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 factory)
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.ICustomParametersUpdateable
updateCustomParams
-
Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
execute, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedExecutionResultDescriptor
getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding
getType
-
Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer
createFlowGraph
-
-
-
-
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 factory)
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:
factory
- 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.
-
-