Interface INodeHandler<TData>
-
- Type Parameters:
TData
- Type of the properties model for the node. UseJSONObject
if you want to get the raw data and possibly perform serialization / deserialization yourself. SeeIElementHandler.getDataModelClass()
.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,IResourceBundleLocator
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Subinterfaces:
IBaseActionNode<TData>
,IBeanValidatingNode<TData>
,IBuiltinNodeType<TData>
,IDefaultClientHandlerNode<TData>
,IExecutingLikeActionNode<TData>
,IExecutingLikeBinarySelectionNode<TData>
,IExecutingLikeExceptionHandlerNode<TData>
,IExecutingLikeReturningActionNode<TData>
,IExecutingLikeReturnNode<TData>
,IExecutingLikeSequenceNode<TData>
,IExecutingLikeThrowNode<TData>
,IFileProviding<TData>
,IOfficialHelpPageNode<TData>
,IPluginActionNodeHandler<TData>
,IResultlessNode<TData>
,ISemverUpdatingNode<TData>
,ISingleBaseActionBuiltinNodePrototype<TData>
,ISingleBaseActionNodePrototype<TData>
,ISingleBuiltinNodePrototype<TData>
,ISingleNodePrototype<TData>
- All Known Implementing Classes:
APluginActionNodeHandler
,FcChangeFormAvailabilityHandler
,FcChangeFormValueHandler
,FcChangeStateHandler
,FcCompressAsZipHandler
,FcCopyFormRecordHandler
,FcCounterHandler
,FcCreateTextFileHandler
,FcDeleteFormRecordHandler
,FcDoiInitHandler
,FcEmailHandler
,FcEmptyHandler
,FcExperimentHandler
,FcExportToPersistenceHandler
,FcExportToXmlHandler
,FcFillPdfHandler
,FcFillWordHandler
,FcHttpRequestHandler
,FcImportFormValueFromXmlHandler
,FcLdapQueryHandler
,FcMoveFormRecordToInboxHandler
,FcMultipleConditionHandler
,FcProvideResourceHandler
,FcQueueTaskHandler
,FcRedirectHandler
,FcRenewProcessIdHandler
,FcReturnFileHandler
,FcReturnHandler
,FcSaveToFileSystemHandler
,FcSequenceHandler
,FcSetSavedFlagHandler
,FcShowTemplateHandler
,FcSqlStatementHandler
,FcThrowExceptionHandler
,FcWriteFormRecordAttrHandler
public interface INodeHandler<TData> extends IElementHandler<TData,WorkflowNode>, IWorkflowNodeFlowAnalyzer<TData>, IWorkflowNodeTypeProviding, IExecutionResultDescriptor
All node handlers must be thread-safe. Usually you should not have any instance fields in your handler.Interface for registering workflow nodes. Each workflow node is of a given type, and a handler needs to be registered for each type. The handler is responsible for processing the node during execution, for displaying the node during editing, and for validating the node.
For plugins, it is strongly recommended that you override
IElementHandler.getVersion()
and use the version of the plugin instead. You should also overrideIElementHandler.getResourceBundle(java.util.Locale)
and provide a resource bundle for your plugin.Each action may create data when it is executed, that describe the result of the action. This may include, for example, a status message or a list of values fetched from a network. This interface contains the descriptors that describe the type of data that is created in case the action succeeds and fails, see
IExecutionResultDescriptor
.- Since:
- 7.0.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 Abstract Methods Default Methods Modifier and Type Method Description INormalCompletionResult
execute(INodeExecutionParams<TData> params)
Executes the given workflow node.default String
getLocalizedTypeName(Locale locale)
Finds the localized name of this node type.List<INodePrototypeDescriptor<TData>>
getNodePrototypes(IGetNodePrototypesParams params)
Returns a list of all node prototypes for this node type.default Class<? extends INodePropertiesBean<TData>>
getPropertiesBeanClass()
Returns the class of the bean that should be used when editing the properties of a workflow element.default boolean
isCreateProtocolEntryAfterExecution(boolean success)
Controls whether a protocol entry is created after the node was executed.default boolean
isReplacePlaceholderBeforeExecution()
Whether to replace allString
fields annotated withPlaceholder
in the properties model automatically before execution.-
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, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, 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, getSuccessValueDescriptor
-
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
-
execute
INormalCompletionResult execute(INodeExecutionParams<TData> params) throws AbstractAbruptCompletionException
Executes the given workflow node. You may perform any action required by this node type, such as creating files, sending HTTP requests etc. If this node has children that need to be executed (such as for control nodes like conditions or switches), you must useIWorkflowExecutionContext.executor()
.In case you throw any other exception other than the exceptions mentioned in the throws clause, it will be wrapped in a
NodeThrewException
.- Parameters:
params
- The node that needs to be executed and the current workflow context.- Returns:
- The result value or values created by the executed node.
- Throws:
AbstractAbruptCompletionException
- When the execution of the node could not be completed normally, see below.NodeThrewException
- When the execution of the node could not be completed normally due to abnormal circumstances. When this exception is thrown, execution of the workflow is cancelled, unless an error handler has been defined (such as via a try-catch node).NodeReturnedException
- When the execution of the node could not be completed normally due to a return statement. To end the execution of the workflow and return, throw this exception.
-
getLocalizedTypeName
default String getLocalizedTypeName(Locale locale)
Finds the localized name of this node type. The default implementation uses the keywf.node.[TYPE]
, and looks up the key in theIElementHandler.getResourceBundle(Locale)
. If it cannot be found there, it looks it up in the built-in resource bundles. If it cannot be found there either, returns#getType()
.- Specified by:
getLocalizedTypeName
in interfaceIElementHandler<TData,WorkflowNode>
- Parameters:
locale
- Locale for which the type name should be returned.- Returns:
- A human-readable name of this node type in the given locale.
-
getNodePrototypes
List<INodePrototypeDescriptor<TData>> getNodePrototypes(IGetNodePrototypesParams params)
Returns a list of all node prototypes for this node type. Each prototype appears in the drawer panel of the workflow designer. The user can move a node prototype via drag & drop into the design area in the center to add the node to the current flowchart.You should always return all prototypes, irrespective of whether they are allowed to the current user.
IElementHandler.isAvailable(IIsAvailableParams)
is checked by the engine, and unavailable node types are removed automatically.- Parameters:
params
- Parameters for this method, such as the current locale for localizing the display name of the prototypes.- Returns:
- A list of all available prototypes.
null
is treated as an empty list. - Throws:
RuntimeException
- This method should normally not throw an exception. A runtime exception may be thrown when the node prototypes cannot be created for an unknown reason. When an exception is thrown, no node prototypes are made available for this handler.
-
getPropertiesBeanClass
default Class<? extends INodePropertiesBean<TData>> getPropertiesBeanClass()
Description copied from interface:IElementHandler
Returns the class of the bean that should be used when editing the properties of a workflow element. May benull
if you do not required any bean or custom logic. When you only wish to access the properties of yourIElementHandler.getDataModelClass()
, you do have to use a custom bean - the model is available via the expression language variablemodel
. SeeIElementHandler.getPropertiesViewXhtml()
for further details.The default returns
null
, which uses no extra bean. An extra bean may not be required for simple UIs if you only need to access the properties model of the workflow element - seeIElementHandler.getPropertiesViewXhtml()
.- Specified by:
getPropertiesBeanClass
in interfaceIElementHandler<TData,WorkflowNode>
- Returns:
- The class of the bean to use for editing a workflow node's properties.
- See Also:
IElementHandler.getPropertiesViewXhtml()
-
isCreateProtocolEntryAfterExecution
default boolean isCreateProtocolEntryAfterExecution(boolean success)
Controls whether a protocol entry is created after the node was executed.The default implementation always returns
true
. May be set tofalse
for nodes such as flow control nodes (if-else, try-catch etc.).- Parameters:
success
- Whether the action was executed successfully.- Returns:
true
to create a protocol entry, orfalse
otherwise.
-
isReplacePlaceholderBeforeExecution
default boolean isReplacePlaceholderBeforeExecution()
Whether to replace allString
fields annotated withPlaceholder
in the properties model automatically before execution.Specifically: When this returns
true
andTData
is not setJSONObject
,IWorkflowPlaceholderHandler#replaceStringFields
is invoked on the properties model before it is passed to the#execute
viaINodeExecutionParams#getData
. When this returnsfalse
, no such call is made. Defaults totrue
when not overridden.- Returns:
true
to replace placeholders in the properties model automatically before execution, orfalse
otherwise.
-
-