Interface ISingleTriggerPrototype<TData>
-
- Type Parameters:
TData
- Type of the triggers's properties model.
- All Superinterfaces:
ICustomParametersUpdateable
,IElementHandler<TData,WorkflowTrigger>
,IResourceBundleLocator
,ISingleElementPrototype<TData,WorkflowTrigger>
,ITriggerDataDescriptor
,ITriggerHandler<TData>
,IWorkflowElementTypeProviding
,IWorkflowTriggerTypeProviding
- All Known Subinterfaces:
IPluginTriggerHandler<TData>
,ISingleBaseBuiltinTriggerPrototype<TData>
,ISingleBaseTriggerPrototype<TData>
,ISingleBuiltinTriggerPrototype<TData>
- All Known Implementing Classes:
APluginTriggerHandler
,FcCatchErrorHandler
,FcDoiVerifiedHandler
,FcFormSubmitButtonHandler
,FcInvitationErrorHandler
,FcInvitationSentHandler
,FcManualHandler
,FcStateTimerHandler
,FcTimePointHandler
public interface ISingleTriggerPrototype<TData> extends ITriggerHandler<TData>, ISingleElementPrototype<TData,WorkflowTrigger>
Mixin that implementsITriggerHandler.getTriggerPrototypes(IGetTriggerPrototypesParams)
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
All Methods Instance Methods Default Methods Modifier and Type Method Description default WorkflowTrigger
getPrototypeElement(IGetElementPrototypesParams params)
default List<ITriggerPrototypeDescriptor<TData>>
getTriggerPrototypes(IGetTriggerPrototypesParams params)
Returns a list of all trigger prototypes for this node type.-
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, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, 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, getPrototypeModelData, getPrototypeSearchText, getPrototypeSortKey, getPrototypeSubLabel, getPrototypeTags, getPrototypeTitle, getSubCategory
-
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
-
getPrototypeElement
default WorkflowTrigger getPrototypeElement(IGetElementPrototypesParams params)
- Specified by:
getPrototypeElement
in interfaceISingleElementPrototype<TData,WorkflowTrigger>
- 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.
-
getTriggerPrototypes
default List<ITriggerPrototypeDescriptor<TData>> getTriggerPrototypes(IGetTriggerPrototypesParams params)
Description copied from interface:ITriggerHandler
Returns a list of all trigger prototypes for this node type. Each prototype appears in the drawer panel of the workflow designer. The user can move a trigger prototype via drag & drop into the design area in the center to add the trigger 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 trigger types are removed automatically.- Specified by:
getTriggerPrototypes
in interfaceITriggerHandler<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.
-
-