Package de.xima.fc.workflow.mixin
Class APluginDoUntilLoopNodeHandler<TData extends BaseDoUntilLoopProps,TState extends IWorkflowLoopDataProviding>
- java.lang.Object
-
- de.xima.fc.workflow.mixin.APluginDoUntilLoopNodeHandler<TData,TState>
-
- Type Parameters:
TData
- Type of the node's properties model, seeIPluginDoUntilLoopNodeHandler
.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 toObject
.
- All Implemented Interfaces:
INameProviding
,ITransferable
,INamedUiElement
,IResourceBundleLocator
,IWorkflowNodeFlowAnalyzer<TData>
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,IRefinedExecutionResultDescriptor<TData>
,ICustomParametersUpdateable
,IWorkflowElementTypeProviding
,IBeanValidatingElement<TData,WorkflowNode>
,IBeanValidatingNode<TData>
,IExecutingLikePostTestLoopNode<TData>
,IHierarchyValidatingNode<TData>
,ISingleElementPrototype<TData,WorkflowNode>
,ISingleNodePrototype<TData>
,INodeHandler<TData>
,IWorkflowNodeTypeProviding
,IPluginGenericCustomGUI<IPluginWorkflowNodeBean>
,IFCPlugin
,IPluginWorkflowNode
,IBaseDoUntilLoopClientHandlerNode<TData>
,IPluginDoUntilLoopNodeHandler<TData,TState>
,ISingleBaseDoUntilLoopNodePrototype<TData>
,Serializable
public abstract class APluginDoUntilLoopNodeHandler<TData extends BaseDoUntilLoopProps,TState extends IWorkflowLoopDataProviding> extends Object implements IPluginDoUntilLoopNodeHandler<TData,TState>
Abstract base class meant forIPluginWorkflowNode
plugins that only wish to provide a do-until loop with a custom test.Eliminates the last bits of boilerplate code remaining in
IPluginDoUntilLoopNodeHandler
. When you do not need a different super class, you may use this. Otherwise, just implement the mixinIPluginDoUntilLoopNodeHandler
and add a getter forIPluginDoUntilLoopNodeHandler.getPluginInitializeData()
. SeeIPluginWhileLoopNodeHandler
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 APluginDoUntilLoopNodeHandler()
-
Method Summary
All Methods Instance Methods Concrete Methods 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.IBaseDoUntilLoopClientHandlerNode
getCascadingStyleSheet, getDoUntilLoopOptions, getJavaScript, 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.IExecutingLikePostTestLoopNode
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.IPluginDoUntilLoopNodeHandler
addCurrentValueDescriptorEntries, addSuccessValueDescriptorEntries, beginRepetition, endRepetition, evaluateDoUntilLoopTest, 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.ISingleBaseDoUntilLoopNodePrototype
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
-
-
-
-
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 interfaceIFCPlugin
- 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 interfaceIPluginDoUntilLoopNodeHandler<TData extends BaseDoUntilLoopProps,TState extends IWorkflowLoopDataProviding>
- Returns:
- The
IPluginInitializeData
, as they were passed toIFCPlugin.initialize(IPluginInitializeData)
. Implementation should usually just store the data in aprivate volatile
field and return it in this method.
-
-