Interface ISingleBuiltinNodePrototype<TData>
-
- Type Parameters:
TData
- Type of the node's properties model.
- All Superinterfaces:
Comparable<IOrderable>
,IBuiltinNodeType<TData>
,ICustomParametersUpdateable
,IElementHandler<TData,WorkflowNode>
,IExecutionResultDescriptor
,IListenerRegistrator
,INodeHandler<TData>
,IOfficialHelpPageElement<TData,WorkflowNode>
,IOfficialHelpPageNode<TData>
,IOrderable
,IResourceBundleLocator
,ISingleElementPrototype<TData,WorkflowNode>
,ISingleNodePrototype<TData>
,IWorkflowElementTypeProviding
,IWorkflowNodeFlowAnalyzer<TData>
,IWorkflowNodeTypeProviding
- All Known Subinterfaces:
ISingleBaseActionBuiltinNodePrototype<TData>
- All Known Implementing Classes:
FcChangeFormAvailabilityHandler
,FcChangeFormValueHandler
,FcCompressAsZipHandler
,FcCopyFormRecordHandler
,FcCounterHandler
,FcCreateTextFileHandler
,FcDeleteFormRecordHandler
,FcDoiInitHandler
,FcEmailHandler
,FcExperimentHandler
,FcExportToPersistenceHandler
,FcExportToXmlHandler
,FcFillPdfHandler
,FcFillWordHandler
,FcHttpRequestHandler
,FcImportFormValueFromXmlHandler
,FcLdapQueryHandler
,FcMoveFormRecordToInboxHandler
,FcMultipleConditionHandler
,FcProvideResourceHandler
,FcQueueTaskHandler
,FcRedirectHandler
,FcRenewProcessIdHandler
,FcReturnFileHandler
,FcReturnHandler
,FcSaveToFileSystemHandler
,FcSetSavedFlagHandler
,FcShowTemplateHandler
,FcSqlStatementHandler
,FcThrowExceptionHandler
,FcWriteFormRecordAttrHandler
public interface ISingleBuiltinNodePrototype<TData> extends ISingleNodePrototype<TData>, IBuiltinNodeType<TData>
Mixin that extendsISingleNodePrototype
for builtin node types. For internal use only, should not be used by plugins.- 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 Default Methods Modifier and Type Method Description default IGuiIcon
getPrototypeIcon(IGetElementPrototypesParams params)
default String
getPrototypeLabel(IGetElementPrototypesParams params)
default String
getPrototypeSearchText(IGetElementPrototypesParams params)
default String
getPrototypeSortKey(String label, IGetElementPrototypesParams params)
default String
getPrototypeSubLabel(IGetElementPrototypesParams params)
default String
getPrototypeTitle(IGetElementPrototypesParams params)
-
Methods inherited from interface de.xima.fc.workflow.mixin.IBuiltinNodeType
getBuiltinType, getOfficialHelpPagePath, getType, isAvailable, register
-
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, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, 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.IOfficialHelpPageElement
getHelpPageLocation
-
Methods inherited from interface de.xima.fc.listener.IOrderable
compareTo, shouldBeAfter
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype
getMainCategory, getPrototypeModelData, getPrototypeTags, getSubCategory
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleNodePrototype
getNodePrototypes, getPrototypeElement
-
Methods inherited from interface de.xima.fc.interfaces.workflow.analysis.IWorkflowNodeFlowAnalyzer
createFlowGraph
-
-
-
-
Method Detail
-
getPrototypeIcon
default IGuiIcon getPrototypeIcon(IGetElementPrototypesParams params)
- Specified by:
getPrototypeIcon
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The icon for the element prototype, shown in the element drawer panel to the left of the workflow designer.
See
IElementPrototypeDescriptor.getIcon()
.
-
getPrototypeLabel
default String getPrototypeLabel(IGetElementPrototypesParams params)
- Specified by:
getPrototypeLabel
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The icon for the element prototype, shown in the element drawer panel to the left of the workflow designer.
See
IElementPrototypeDescriptor.getLabel()
.
-
getPrototypeSearchText
default String getPrototypeSearchText(IGetElementPrototypesParams params)
- Specified by:
getPrototypeSearchText
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The search text for the element prototype, never shown to the user but used for filtering. See
IElementPrototypeDescriptor.getSearchText()
.
-
getPrototypeSortKey
default String getPrototypeSortKey(String label, IGetElementPrototypesParams params)
- Specified by:
getPrototypeSortKey
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
label
- The label, as returned byISingleElementPrototype.getPrototypeLabel(IGetElementPrototypesParams)
. Can be used to sort the prototype alphabetically by its name.params
- Parameters with the current client, locale, entity context etc.- Returns:
- The sort key for the prototype, used when there are multiple prototypes within the same category. See
IElementPrototypeDescriptor.getSortKey()
.
-
getPrototypeSubLabel
default String getPrototypeSubLabel(IGetElementPrototypesParams params)
- Specified by:
getPrototypeSubLabel
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The sub label for the element prototype, shown in the element drawer panel to the left of the workflow
designer. See
IElementPrototypeDescriptor.getLabel()
.
-
getPrototypeTitle
default String getPrototypeTitle(IGetElementPrototypesParams params)
- Specified by:
getPrototypeTitle
in interfaceISingleElementPrototype<TData,WorkflowNode>
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- The title for the element prototype, shown in the element drawer panel to the left of the workflow
designer. See
IElementPrototypeDescriptor.getLabel()
.
-
-