Package de.xima.fc.workflow.mixin
Interface ISingleBaseTriggerPrototype<TData extends BaseTriggerProps>
-
- Type Parameters:
TData
- Type of the trigger's properties model.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowTrigger>
,IResourceBundleLocator
,ISingleElementPrototype<TData,WorkflowTrigger>
,ISingleTriggerPrototype<TData>
,ITriggerDataDescriptor
,ITriggerHandler<TData>
,IWorkflowElementTypeProviding
,IWorkflowTriggerTypeProviding
- All Known Subinterfaces:
IPluginTriggerHandler<TData>
,ISingleBaseBuiltinTriggerPrototype<TData>
- All Known Implementing Classes:
APluginTriggerHandler
,FcCatchErrorHandler
,FcDoiVerifiedHandler
,FcFormSubmitButtonHandler
,FcInvitationErrorHandler
,FcInvitationSentHandler
,FcManualHandler
,FcStateTimerHandler
,FcTimePointHandler
public interface ISingleBaseTriggerPrototype<TData extends BaseTriggerProps> extends ISingleTriggerPrototype<TData>
A mixin for all triggers that areISingleTriggerPrototype
and additionally use a properties model that extends fromBaseTriggerProps
. Creates a new instance of the properties model via reflection and sets the basic properties (name, color, icon).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.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 TData
getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
This default implementation returns a new instance of theTData
properties model, pre-filled with the label and icon (BaseActionProps.getName()
andBaseActionProps.getIcon()
).default ClientOpaqueColor
getThemeColor()
-
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.mixin.ISingleElementPrototype
getMainCategory, getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSortKey, getPrototypeSubLabel, getPrototypeTags, getPrototypeTitle, getSubCategory
-
Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleTriggerPrototype
getPrototypeElement, getTriggerPrototypes
-
Methods inherited from interface de.xima.fc.interfaces.workflow.execution.ITriggerDataDescriptor
getTriggerDataDescriptor
-
Methods inherited from interface de.xima.fc.interfaces.workflow.triggers.ITriggerHandler
getFilterCriteriaForEvent, getLocalizedTypeName, getPropertiesBeanClass, isAppliesToEvent, isPreconditionSatisfied, onTaskBegin, onTaskFinish
-
Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementTypeProviding
getType
-
-
-
-
Method Detail
-
getPrototypeModelData
default TData getPrototypeModelData(String label, IGuiIcon icon, IGetElementPrototypesParams params)
This default implementation returns a new instance of theTData
properties model, pre-filled 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 BaseTriggerProps,WorkflowTrigger>
- 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)
-
getThemeColor
default ClientOpaqueColor getThemeColor()
- Returns:
- The theme color for this action. This color is used for the visual representation in the workflow designer.
-
-