Package de.xima.fc.interfaces.workflow.mixin

Interface ISingleNodePrototype<TData>

Type Parameters:

TData - Type of the node's properties model.

All Superinterfaces:

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

All Known Subinterfaces:

IPluginActionNodeHandler<TData>, ISingleBaseActionBuiltinNodePrototype<TData>, ISingleBaseActionNodePrototype<TData>, ISingleBuiltinNodePrototype<TData>

All Known Implementing Classes:

APluginActionNodeHandler, FcChangeFormAvailabilityHandler, FcChangeFormValueHandler, FcCompressAsZipHandler, FcCopyFormRecordHandler, FcCounterHandler, FcCreateTextFileHandler, FcDeleteFormRecordHandler, FcDoiInitHandler, FcEmailHandler, FcExperimentHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcImportFormValueFromXmlHandler, FcLdapQueryHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcPostRequestHandler, FcProvideResourceHandler, FcQueueTaskHandler, FcRedirectHandler, FcRenewProcessIdHandler, FcReturnFileHandler, FcReturnHandler, FcSaveToFileSystemHandler, FcSetSavedFlagHandler, FcShowTemplateHandler, FcSqlStatementHandler, FcThrowExceptionHandler, FcWriteFormRecordAttrHandler

public interface ISingleNodePrototype<TData>
extends INodeHandler<TData>, ISingleElementPrototype<TData,WorkflowNode>

Mixin that implements INodeHandler.getNodePrototypes(IGetNodePrototypesParams) for cases when a handler only wishes to provide a single prototype. This interface contains several method for the different details of the prototype.

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

Modifier and Type	Method	Description
default List<INodePrototypeDescriptor<TData>>	getNodePrototypes(IGetNodePrototypesParams params)	Returns a list of all node prototypes for this node type.
default WorkflowNode	getPrototypeElement(IGetElementPrototypesParams params)

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.nodes.INodeHandler

execute, getLocalizedTypeName, getPropertiesBeanClass, isCreateProtocolEntryAfterExecution, isReplacePlaceholderBeforeExecution

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

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

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

getNodePrototypes

default List<INodePrototypeDescriptor<TData>> getNodePrototypes(IGetNodePrototypesParams params)

Description copied from interface: INodeHandler

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.

Specified by:

getNodePrototypes in interface INodeHandler<TData>

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.

getPrototypeElement

default WorkflowNode getPrototypeElement(IGetElementPrototypesParams params)

Specified by:

getPrototypeElement in interface ISingleElementPrototype<TData,WorkflowNode>

Parameters:

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

Returns:

The workflow element that is used as a prototype. The default implementation simply creates a new workflow element with the IWorkflowElementTypeProviding.getType(). Usually there is no reason to override this method.