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, FcVoidHandler

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 IElementHandler

CURRENT_HANDLER_VERSION

Method Summary

Modifier and Type	Method	Description
default IUnionValueDescriptor	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 ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface IElementHandler

extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getFilterCriteriaForObjects, getHelpPageLocation, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readObjectReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writeObjectReferences, writePlaceholders

Methods inherited from interface IExecutionResultDescriptor

getAlwaysValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors

Methods inherited from interface INodeHandler

execute, getBpmnModeler, getLocalizedTypeName, getNodePrototypes, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface IRefinedExecutionResultDescriptor

getAlwaysValueDescriptor, getAlwaysValueDescriptor, getAttachmentValueDescriptor, getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getCurrentFileValueDescriptor, getCurrentValueDescriptor, getCurrentValueDescriptor, getErrorValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSoftErrorValueDescriptors, getSuccessValueDescriptor, getSuccessValueDescriptor

Methods inherited from interface IWorkflowElementTypeProviding

getType

Methods inherited from interface IWorkflowNodeFlowAnalyzer

createFlowGraph

Method Details

getErrorValueDescriptor

default IUnionValueDescriptor 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 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 interface IExecutionResultDescriptor

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.

Returns:

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