Interface ISingleElementPrototype<TData,TElement extends IWorkflowElementEntity>
-
- Type Parameters:
TData
- Type of the node's properties model.TElement
- Type of the workflow element (node or trigger).
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,TElement>
,IResourceBundleLocator
,IWorkflowElementTypeProviding
- All Known Subinterfaces:
IPluginActionNodeHandler<TData>
,IPluginTriggerHandler<TData>
,ISingleBaseActionBuiltinNodePrototype<TData>
,ISingleBaseActionNodePrototype<TData>
,ISingleBaseBuiltinTriggerPrototype<TData>
,ISingleBaseTriggerPrototype<TData>
,ISingleBuiltinNodePrototype<TData>
,ISingleBuiltinTriggerPrototype<TData>
,ISingleNodePrototype<TData>
,ISingleTriggerPrototype<TData>
- All Known Implementing Classes:
APluginActionNodeHandler
,APluginTriggerHandler
,FcCatchErrorHandler
,FcChangeFormAvailabilityHandler
,FcChangeFormValueHandler
,FcCompressAsZipHandler
,FcCopyFormRecordHandler
,FcCounterHandler
,FcCreateTextFileHandler
,FcDeleteFormRecordHandler
,FcDoiInitHandler
,FcDoiVerifiedHandler
,FcEmailHandler
,FcExperimentHandler
,FcExportToPersistenceHandler
,FcExportToXmlHandler
,FcFillPdfHandler
,FcFillWordHandler
,FcFormSubmitButtonHandler
,FcHttpRequestHandler
,FcImportFormValueFromXmlHandler
,FcInvitationErrorHandler
,FcInvitationSentHandler
,FcLdapQueryHandler
,FcManualHandler
,FcMoveFormRecordToInboxHandler
,FcMultipleConditionHandler
,FcProvideResourceHandler
,FcQueueTaskHandler
,FcRedirectHandler
,FcRenewProcessIdHandler
,FcReturnFileHandler
,FcReturnHandler
,FcSaveToFileSystemHandler
,FcSetSavedFlagHandler
,FcShowTemplateHandler
,FcSqlStatementHandler
,FcStateTimerHandler
,FcThrowExceptionHandler
,FcTimePointHandler
,FcWriteFormRecordAttrHandler
public interface ISingleElementPrototype<TData,TElement extends IWorkflowElementEntity> extends IElementHandler<TData,TElement>
Element handler mixin 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
- See Also:
ISingleNodePrototype
,ISingleTriggerPrototype
-
-
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 IElementCategory
getMainCategory(IGetElementPrototypesParams params)
TElement
getPrototypeElement(IGetElementPrototypesParams params)
IGuiIcon
getPrototypeIcon(IGetElementPrototypesParams params)
String
getPrototypeLabel(IGetElementPrototypesParams params)
TData
getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
String
getPrototypeSearchText(IGetElementPrototypesParams params)
default String
getPrototypeSortKey(String label, IGetElementPrototypesParams params)
String
getPrototypeSubLabel(IGetElementPrototypesParams params)
default Set<EElementPrototypeTag>
getPrototypeTags(IGetElementPrototypesParams params)
Optional tags for the prototype, seeIElementPrototypeDescriptor.getTags()
.String
getPrototypeTitle(IGetElementPrototypesParams params)
default IElementCategory
getSubCategory(IGetElementPrototypesParams params)
Optional sub category.-
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, getLocalizedTypeName, getPropertiesBeanClass, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders
-
Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding
getType
-
-
-
-
Method Detail
-
getMainCategory
IElementCategory getMainCategory(IGetElementPrototypesParams params)
- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
IElementCategory
element's main category, which is used for grouping the elements.- 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.
-
getPrototypeElement
TElement getPrototypeElement(IGetElementPrototypesParams params)
- 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. - 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.
-
getPrototypeIcon
IGuiIcon getPrototypeIcon(IGetElementPrototypesParams params)
- 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
String getPrototypeLabel(IGetElementPrototypesParams params)
- 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()
. - 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.
-
getPrototypeModelData
TData getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
- Parameters:
label
- Label of the prototype, as returned bygetPrototypeLabel(IGetElementPrototypesParams)
. Can be used to prefill the properties model with the label.icon
- Icon of the prototype, as returned bygetPrototypeIcon(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).
- 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.
-
getPrototypeSearchText
String getPrototypeSearchText(IGetElementPrototypesParams params)
- 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()
. - 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.
-
getPrototypeSortKey
default String getPrototypeSortKey(String label, IGetElementPrototypesParams params)
- Parameters:
label
- The label, as returned bygetPrototypeLabel(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()
. - 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.
-
getPrototypeSubLabel
String getPrototypeSubLabel(IGetElementPrototypesParams params)
- 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()
. - 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.
-
getPrototypeTags
default Set<EElementPrototypeTag> getPrototypeTags(IGetElementPrototypesParams params)
Optional tags for the prototype, seeIElementPrototypeDescriptor.getTags()
.- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
- Set of tags for the node prototype.
-
getPrototypeTitle
String getPrototypeTitle(IGetElementPrototypesParams params)
- 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()
. - 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.
-
getSubCategory
default IElementCategory getSubCategory(IGetElementPrototypesParams params)
Optional sub category. When not set or this returnsnull
, the element is shown under the categorymiscellaneous
.- Parameters:
params
- Parameters with the current client, locale, entity context etc.- Returns:
IElementCategory
element's sub category, which is used for grouping the element within the given main group.- 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.
-
-