Interface IBeanValidatingNode<TData>

Type Parameters:

TData - Type of the node's properties model.

All Superinterfaces:

IBeanValidatingElement<TData, WorkflowNode>, ICustomParametersUpdateable, IElementHandler<TData, WorkflowNode>, IExecutionResultDescriptor, IHierarchyValidatingNode<TData>, INodeHandler<TData>, IRefinedExecutionResultDescriptor<TData>, IResourceBundleLocator, IWorkflowElementTypeProviding, IWorkflowNodeFlowAnalyzer<TData>, IWorkflowNodeTypeProviding

All Known Subinterfaces:

IBaseActionNode<TData>, IPluginActionNodeHandler<TData>, IPluginConditionNodeHandler<TData>, IPluginDoUntilLoopNodeHandler<TData,TState>, IPluginWhileLoopNodeHandler<TData,TState>

All Known Implementing Classes:

APluginActionNodeHandler, APluginConditionNodeHandler, APluginDoUntilLoopNodeHandler, APluginWhileLoopNodeHandler, FcBreakHandler, FcChangeFormAvailabilityHandler, FcChangeFormRecordChatActivenessHandler, FcChangeFormValueHandler, FcChangeStateHandler, FcCompressAsZipHandler, FcContinueHandler, FcCopyFormRecordHandler, FcCounterHandler, FcCreateTextFileHandler, FcDecodeBase64Handler, FcDeleteAttachmentHandler, FcDeleteFormRecordHandler, FcDoiInitHandler, FcDoUntilLoopHandler, FcEmailHandler, FcEncodeBase64Handler, FcExperimentHandler, FcExportFormRecordChatsHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcForEachLoopHandler, FcHttpRequestHandler, FcImportFormValueFromXmlHandler, FcLdapQueryHandler, FcLogEntryHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcProcessHistoryPdfHandler, FcProcessLogPdfHandler, FcPromptQueryHandler, FcProvideResourceHandler, FcQueueTaskHandler, FcRedirectHandler, FcRenewProcessIdHandler, FcReturnFileHandler, FcReturnHandler, FcSaveToFileSystemHandler, FcSaveToWebDavHandler, FcSendFormRecordMessageHandler, FcSetFormRecordPasswordHandler, FcSetSavedFlagHandler, FcShowTemplateHandler, FcSqlStatementHandler, FcSwitchCaseHandler, FcSwitchDefaultHandler, FcSwitchHandler, FcThrowExceptionHandler, FcWhileLoopHandler, FcWithFormElementContextHandler, FcWriteFormRecordAttrHandler

public interface IBeanValidatingNode<TData>
extends IHierarchyValidatingNode<TData>, IBeanValidatingElement<TData, WorkflowNode>, INodeHandler<TData>

Mixin that implements IElementHandler.validateLocal(IElementLocalValidationParams) by performing a bean validation on the node's properties model. See IBeanValidatingElement for more details.

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 IWorkflowElementValidationResult	validateLocal(IElementLocalValidationParams<TData, WorkflowNode> params)	Performs a local validation of the given workflow element properties.

Methods inherited from interface IBeanValidatingElement

getValidationGroups

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

Methods inherited from interface IExecutionResultDescriptor

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

Methods inherited from interface IHierarchyValidatingNode

isValidChildCount, isValidChildType, isValidParentType

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

validateLocal

default IWorkflowElementValidationResult validateLocal(IElementLocalValidationParams<TData, WorkflowNode> params)
                                                throws WorkflowValidationException

Description copied from interface: IElementHandler

Performs a local validation of the given workflow element properties. This method should only validate the properties of the given workflow element, without respect to any other workflow elements.

This method allows you to implement custom validation logic. Consider using IBeanValidatingElement and annotating your properties model class with the annotation from the bean annotation API javax.validation. This also offers the advantage that it can be integrated into JSF, allowing you to use the same validations for the UI view as well.

Specified by:

validateLocal in interface IBeanValidatingElement<TData, WorkflowNode>

Specified by:

validateLocal in interface IElementHandler<TData, WorkflowNode>

Specified by:

validateLocal in interface IHierarchyValidatingNode<TData>

Parameters:

params - The properties to validate. Also provides access to the project, client etc.

Returns:

The result of the validation, i.e. whether the workflow element is valid, and a list of messages to display to the user. If this returns, this is treated as if a valid result without messages had been returned. You may use params.getValidationContext().resultBuilder() to create the result, or implement the interface yourself. To indicate that the validation was performed, but no validation constraints were violated, simply call build on the result builder and return that, without adding any messages.

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.