Package de.xima.fc.workflow.mixin

Interface ISingleBaseWhileLoopNodePrototype<TData extends BaseWhileLoopProps>

Type Parameters:

TData - Type of the node's properties model.

All Superinterfaces:

ICustomParametersUpdateable, IElementHandler<TData,WorkflowNode>, IExecutionResultDescriptor, INodeHandler<TData>, IRefinedExecutionResultDescriptor<TData>, IResourceBundleLocator, ISingleElementPrototype<TData,WorkflowNode>, ISingleNodePrototype<TData>, IWorkflowElementTypeProviding, IWorkflowNodeFlowAnalyzer<TData>, IWorkflowNodeTypeProviding

All Known Subinterfaces:

IPluginWhileLoopNodeHandler<TData,TState>

All Known Implementing Classes:

APluginWhileLoopNodeHandler

public interface ISingleBaseWhileLoopNodePrototype<TData extends BaseWhileLoopProps>
extends ISingleNodePrototype<TData>

A mixin for all nodes that are ISingleNodePrototype and additionally use a properties model that extends from BaseWhileLoopProps. Creates a new instance of the properties model via reflection and sets the basic properties.

Make sure your properties type TData has a public no-arg constructor.

To add custom defaults, override getPrototypeModelData(String, IGuiIcon, IGetElementPrototypesParams), call the super method, and set additional data on the properties model.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Field Summary

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

CURRENT_HANDLER_VERSION

Method Summary

Modifier and Type	Method	Description
default TData	getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)	This default implementation returns a new instance of the TData properties model, prefilled with the label and icon (BaseActionProps.getName() and BaseActionProps.getIcon()).

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

updateCustomParams

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

extractDescription, extractName, extractSearchTerms, getCascadingStyleSheet, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders

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

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

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

execute, getLocalizedTypeName, getPropertiesBeanClass, getRelatedNodeTypes, getSupportedControlTransferTypes, isCreateProtocolEntryAfterExecution, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

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.interfaces.workflow.mixin.ISingleElementPrototype

getMainCategory, getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSortKey, getPrototypeSubLabel, getPrototypeTags, getPrototypeTitle, getSubCategory

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

getNodePrototypes, getPrototypeElement

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

getType

Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer

createFlowGraph

Method Detail

getPrototypeModelData

default TData getPrototypeModelData(String label,
                                    IGuiIcon icon,
                                    IGetElementPrototypesParams params)

This default implementation returns a new instance of the TData properties model, prefilled with the label and icon (BaseActionProps.getName() and BaseActionProps.getIcon()). All other fields remain at their default values.

This method assumes that the TData type possesses a public no-arg constructor. If it does not, you will need to override this method and create the instance yourself. Otherwise, you can also override this method, call super, and add additional defaults - but make sure JSON deserialization can still create an instance as well, such as via JSONCreator.

Specified by:

getPrototypeModelData in interface ISingleElementPrototype<TData extends BaseWhileLoopProps,WorkflowNode>

Parameters:

label - Label of the prototype, as returned by ISingleElementPrototype.getPrototypeLabel(IGetElementPrototypesParams). Can be used to prefill the properties model with the label.

icon - Icon of the prototype, as returned by ISingleElementPrototype.getPrototypeIcon(IGetElementPrototypesParams). Can be used to prefill the properties model with the icon.

params - Parameters with the current client, locale, entity context etc.

Returns:

The properties model for the element prototype. This is the initial configuration when the user adds the prototype to the flowchart (via drag & drop).

See Also:

ISingleElementPrototype.getPrototypeModelData(String, IGuiIcon, IGetElementPrototypesParams)