Package de.xima.fc.workflow.mixin
Interface ISingleBaseConditionNodePrototype<TData extends BaseConditionProps>
-
- Type Parameters:
TData
- Type of the node's properties model.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,INodeHandler<TData>
,IResourceBundleLocator
,ISingleElementPrototype<TData,WorkflowNode>
,ISingleNodePrototype<TData>
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Subinterfaces:
IPluginConditionNodeHandler<TData>
- All Known Implementing Classes:
APluginConditionNodeHandler
public interface ISingleBaseConditionNodePrototype<TData extends BaseConditionProps> extends ISingleNodePrototype<TData>
A mixin for all nodes that areISingleNodePrototype
and additionally use a properties model that extends fromBaseConditionProps
. 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:
- 7.1.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
-
Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler
CURRENT_HANDLER_VERSION
-
-
Method Summary
All Methods Instance Methods Default Methods Modifier and Type Method Description default TData
getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
This default implementation returns a new instance of theTData
properties model, prefilled with the label and icon (BaseActionProps.getName()
andBaseActionProps.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, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IExecutionResultDescriptor
getAlwaysValueDescriptor, getErrorValueDescriptor, getFileValueDescriptor, getSoftErrorValueDescriptor, getSuccessValueDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.nodes.INodeHandler
execute, getLocalizedTypeName, getPropertiesBeanClass, getRelatedNodeTypes, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution
-
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 theTData
properties model, prefilled with the label and icon (BaseActionProps.getName()
andBaseActionProps.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, callsuper
, and add additional defaults - but make sure JSON deserialization can still create an instance as well, such as viaJSONCreator
.- Specified by:
getPrototypeModelData
in interfaceISingleElementPrototype<TData extends BaseConditionProps,WorkflowNode>
- Parameters:
label
- Label of the prototype, as returned byISingleElementPrototype.getPrototypeLabel(IGetElementPrototypesParams)
. Can be used to prefill the properties model with the label.icon
- Icon of the prototype, as returned byISingleElementPrototype.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)
-
-