Package de.xima.fc.workflow.designer.mixin

Interface ISingleBuiltinTriggerPrototype<TData>

Type Parameters:

TData - Type of the trigger's properties model.

All Superinterfaces:

Comparable<IOrderable>, IBuiltinTriggerType<TData>, ICustomParametersUpdateable, IElementHandler<TData,WorkflowTrigger>, IListenerRegistrator, IOfficialHelpPageElement<TData,WorkflowTrigger>, IOfficialHelpPageTrigger<TData>, IOrderable, IResourceBundleLocator, ISingleElementPrototype<TData,WorkflowTrigger>, ISingleTriggerPrototype<TData>, ITriggerDataDescriptor, ITriggerHandler<TData>, IWorkflowElementTypeProviding, IWorkflowTriggerTypeProviding

All Known Subinterfaces:

ISingleBaseBuiltinTriggerPrototype<TData>

All Known Implementing Classes:

FcCatchErrorHandler, FcDoiVerifiedHandler, FcFormSubmitButtonHandler, FcInvitationErrorHandler, FcInvitationSentHandler, FcManualHandler, FcStateTimerHandler, FcTimePointHandler

public interface ISingleBuiltinTriggerPrototype<TData>
extends ISingleTriggerPrototype<TData>, IBuiltinTriggerType<TData>

Mixin that extends ISingleTriggerPrototype for built-in trigger 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

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.IBuiltinTriggerType

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, getCascadingStyleSheet, getDataModelClass, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getJavaScript, getJavaScript, getPropertiesViewXhtml, getResourceBundle, getVersion, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders

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

Method Detail

getPrototypeIcon

default IGuiIcon getPrototypeIcon(IGetElementPrototypesParams params)

Specified by:

getPrototypeIcon in interface ISingleElementPrototype<TData,WorkflowTrigger>

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 interface ISingleElementPrototype<TData,WorkflowTrigger>

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 interface ISingleElementPrototype<TData,WorkflowTrigger>

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 interface ISingleElementPrototype<TData,WorkflowTrigger>

Parameters:

label - The label, as returned by ISingleElementPrototype.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 interface ISingleElementPrototype<TData,WorkflowTrigger>

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 interface ISingleElementPrototype<TData,WorkflowTrigger>

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().