Interface ILoopStatementMustLoopValidating<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:

FcDoUntilLoopHandler, FcForEachLoopHandler, FcWhileLoopHandler

public interface ILoopStatementMustLoopValidating<TData>
extends INodeHandler<TData>

Mixin with an implementation of validateGlobal for node handlers that implement some kind of loop and wish to enforce that a loop is actually possible. Validates the the loop body can complete normally or at least abruptly by issuing a continue statement that targets the loop. Otherwise, it is guaranteed that the loop body is never executed more than once.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

• IExecutingLikePreTestLoopNode
• IExecutingLikePostTestLoopNode

Field Summary

Fields inherited from interface IElementHandler

CURRENT_HANDLER_VERSION

Method Summary

Modifier and Type	Method	Description
int	getLoopBodyChildIndex()
default void	validateGlobal(IElementGlobalValidationParams<TData, WorkflowNode> params)	Similar to validateLocal, but performs validations that require knowledge about other workflow elements.

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, validateLocal, writeEntityReferences, writeObjectReferences, writePlaceholders

Methods inherited from interface IExecutionResultDescriptor

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

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

getLoopBodyChildIndex

int getLoopBodyChildIndex()

Returns:

Index of the child representing the loop body.

validateGlobal

default void validateGlobal(IElementGlobalValidationParams<TData, WorkflowNode> params)
                     throws WorkflowValidationException

Description copied from interface: IElementHandler

Similar to validateLocal, but performs validations that require knowledge about other workflow elements. As such, this method is given access to the entire WorkflowProcess and the list of all workflow elements of the process. This method is then responsible for iterating over all applicable workflow elements, using methods such as getTriggersByType or getNodesByType, and adding the appropriate validation failures via addGlobalValidationMessage and markGlobalValidationFailed.

Specified by:

validateGlobal in interface IElementHandler<TData, WorkflowNode>

Parameters:

params - The workflow task and all workflow elements to validate.

Throws:

WorkflowValidationException - When the validation could not be performed. Please note that this is meant for unexpected errors only - you should not throw an exception if a workflow element is simply just invalid.