Class APluginWhileLoopNodeHandler<TData extends BaseWhileLoopProps, TState extends IWorkflowLoopDataProviding>

java.lang.Object

de.xima.fc.workflow.mixin.APluginWhileLoopNodeHandler<TData,TState>

Type Parameters:

TData - Type of the node's properties model, see IPluginWhileLoopNodeHandler.

TState - Type of the custom state used during the execution of the loop. If you do not require any state, simply set this type parameter to Object.

All Implemented Interfaces:

INameProviding, ITransferable, INamedUiElement, IResourceBundleLocator, IWorkflowNodeFlowAnalyzer<TData>, IElementHandler<TData, WorkflowNode>, IExecutionResultDescriptor, IRefinedExecutionResultDescriptor<TData>, ICustomParametersUpdateable, IWorkflowElementTypeProviding, IBeanValidatingElement<TData, WorkflowNode>, IBeanValidatingNode<TData>, IExecutingLikePreTestLoopNode<TData>, IHierarchyValidatingNode<TData>, ISingleElementPrototype<TData, WorkflowNode>, ISingleNodePrototype<TData>, INodeHandler<TData>, IWorkflowNodeTypeProviding, IPluginGenericCustomGUI<IPluginWorkflowNodeBean>, IFCPlugin, IPluginWorkflowNode, IBaseWhileLoopClientHandlerNode<TData>, IPluginWhileLoopNodeHandler<TData,TState>, ISingleBaseWhileLoopNodePrototype<TData>, Serializable

public abstract class APluginWhileLoopNodeHandler<TData extends BaseWhileLoopProps, TState extends IWorkflowLoopDataProviding>
extends Object
implements IPluginWhileLoopNodeHandler<TData,TState>

Abstract base class meant for IPluginWorkflowNode plugins that only wish to provide a while loop with a custom test.

Eliminates the last bits of boilerplate code remaining in IPluginWhileLoopNodeHandler . When you do not need a different super class, you may use this. Otherwise, just implement the mixin IPluginWhileLoopNodeHandler and add a getter for IPluginWhileLoopNodeHandler.getPluginInitializeData(). See IPluginWhileLoopNodeHandler for further details.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

See Also:

• IPluginWhileLoopNodeHandler
• Serialized Form

Field Summary

Fields inherited from interface IElementHandler

CURRENT_HANDLER_VERSION

Fields inherited from interface IFCPlugin

CONFIG_FILENAME

Fields inherited from interface INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
APluginWhileLoopNodeHandler()

Method Summary

Modifier and Type	Method	Description
IPluginInitializeData	getPluginInitializeData()
void	initialize(IPluginInitializeData initializeData)	Callback method that is invoked when this plugin is initialized.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface IBaseWhileLoopClientHandlerNode

getCascadingStyleSheet, getJavaScript, getWhileLoopOptions, isAlwaysCompletesAbruptly

Methods inherited from interface IBeanValidatingElement

getValidationGroups

Methods inherited from interface IBeanValidatingNode

validateLocal

Methods inherited from interface ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface IElementHandler

extractSearchTerms, getCascadingStyleSheet, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getFilterCriteriaForObjects, getHelpPageLocation, getJavaScript, isAvailable, isHasUserVisibleName, readEntityReferences, readObjectReferences, readPlaceholders, validateGlobal, writeEntityReferences, writeObjectReferences, writePlaceholders

Methods inherited from interface IExecutingLikePreTestLoopNode

createFlowGraph

Methods inherited from interface IExecutionResultDescriptor

getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getErrorValueDescriptors, getFileValueDescriptor, getSoftErrorValueDescriptors

Methods inherited from interface IFCPlugin

getDescription, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Methods inherited from interface IHierarchyValidatingNode

isValidChildCount, isValidChildType, isValidParentType

Methods inherited from interface INodeHandler

getLocalizedTypeName, getRelatedNodeTypes, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface IPluginWhileLoopNodeHandler

addCurrentValueDescriptorEntries, addSuccessValueDescriptorEntries, beginRepetition, endRepetition, evaluateWhileLoopTest, execute, extractDescription, extractName, finishLoop, getAlwaysValueDescriptor, getBpmnModeler, getCurrentValueDescriptor, getDataModelClass, getDescription, getDisplayName, getErrorValueDescriptor, getI18nKeyActionLabel, getI18nKeyActionSearchText, getI18nKeyActionSubLabel, getI18nKeyActionTitle, getI18nKeyDescription, getI18nKeyDisplayName, getLoopBodyChildIndex, getMainCategory, getMainPluginBeanClass, getName, getNodeHandler, getPropertiesBeanClass, getPropertiesViewXhtml, getPropertiesViewXhtmlName, getPropertiesViewXhtmlPath, getPropertyNameCurrentIndex, getPropertyNameIterationCount, getPrototypeElement, getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSubLabel, getPrototypeTitle, getResourceBundle, getResourceBundlePath, getSoftErrorValueDescriptor, getSubCategory, getSuccessValueDescriptor, getSupportedControlTransferTypes, getType, getUnmanagedBeans, getVersion, isCreateProtocolEntryAfterExecution, startLoop

Methods inherited from interface IPluginWorkflowNode

getXhtmlView

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 ISingleBaseWhileLoopNodePrototype

getPrototypeModelData

Methods inherited from interface ISingleElementPrototype

getPrototypeSortKey, getPrototypeTags

Methods inherited from interface ISingleNodePrototype

getNodePrototypes, getPrototypeElementChildren

Constructor Details

APluginWhileLoopNodeHandler

public APluginWhileLoopNodeHandler()

Method Details

initialize

public void initialize(IPluginInitializeData initializeData)
                throws FCPluginException

Description copied from interface: IFCPlugin

Callback method that is invoked when this plugin is initialized.

Specified by:

initialize in interface IFCPlugin

Parameters:

initializeData - IPluginInitializeData

Throws:

FCPluginException - May be thrown when an error occurred during the initialization process. When an error is thrown, this plugin will be deactivated and not put into service.

getPluginInitializeData

public IPluginInitializeData getPluginInitializeData()

Specified by:

getPluginInitializeData in interface IPluginWhileLoopNodeHandler<TData extends BaseWhileLoopProps, TState extends IWorkflowLoopDataProviding>

Returns:

The IPluginInitializeData, as they were passed to IFCPlugin.initialize(IPluginInitializeData). Implementation should usually just store the data in a private volatile field and return it in this method.