Package de.xima.fc.workflow.mixin

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 de.xima.fc.interfaces.workflow.elements.IElementHandler

CURRENT_HANDLER_VERSION

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.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 java.lang.Object

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

Methods inherited from interface de.xima.fc.workflow.mixin.IBaseWhileLoopClientHandlerNode

getCascadingStyleSheet, getJavaScript, getWhileLoopOptions, isAlwaysCompletesAbruptly

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingElement

getValidationGroups

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingNode

validateLocal

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

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

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IExecutingLikePreTestLoopNode

createFlowGraph

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor

getAttachmentValueDescriptor, getCurrentAttachmentValueDescriptor, getCurrentFileValueDescriptor, getFileValueDescriptor

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

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

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IHierarchyValidatingNode

isValidChildCount, isValidChildType, isValidParentType

Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler

getLocalizedTypeName, getRelatedNodeTypes, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

Methods inherited from interface de.xima.fc.workflow.mixin.IPluginWhileLoopNodeHandler

addCurrentValueDescriptorEntries, addSuccessValueDescriptorEntries, beginRepetition, endRepetition, evaluateWhileLoopTest, execute, extractDescription, extractName, finishLoop, getAlwaysValueDescriptor, 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 de.xima.fc.plugin.interfaces.workflow.IPluginWorkflowNode

getXhtmlView

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.workflow.mixin.ISingleBaseWhileLoopNodePrototype

getPrototypeModelData

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype

getPrototypeSortKey, getPrototypeTags

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleNodePrototype

getNodePrototypes

Constructor Detail

APluginWhileLoopNodeHandler

public APluginWhileLoopNodeHandler()

Method Detail

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.