Package de.xima.fc.workflow.mixin

Interface IBuiltinTriggerType<TData>

Type Parameters:

TData - Type of the trigger's properties model.

All Superinterfaces:

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

All Known Subinterfaces:

ISingleBaseBuiltinTriggerPrototype<TData>, ISingleBuiltinTriggerPrototype<TData>

All Known Implementing Classes:

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

public interface IBuiltinTriggerType<TData>
extends ITriggerHandler<TData>, IOfficialHelpPageTrigger<TData>, IListenerRegistrator

Mixin for all built-in workflow trigger handlers.

Takes the AWorkflowElement.getType() from the EWorkflowTriggerType.

Registers the handler when the system is started. EWorkflowTriggerType.

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
EWorkflowTriggerType	getBuiltinType()
default String	getOfficialHelpPagePath()
default String	getType()
default boolean	isAvailable(IIsAvailableParams<TData> params)	Checks whether this workflow element is available to the given client.
default void	register()	Invoked by the system and may perform whatever setup logic is required.

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, isHasUserVisibleName, 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.execution.ITriggerDataDescriptor

getTriggerDataDescriptor

Methods inherited from interface de.xima.fc.interfaces.workflow.triggers.ITriggerHandler

getFilterCriteriaForEvent, getLocalizedTypeName, getPropertiesBeanClass, getTriggerPrototypes, isAppliesToEvent, isPreconditionSatisfied, onTaskBegin, onTaskFinish

Method Detail

getBuiltinType

EWorkflowTriggerType getBuiltinType()

Returns:

The built-in trigger type.

getOfficialHelpPagePath

default String getOfficialHelpPagePath()

Specified by:

getOfficialHelpPagePath in interface IOfficialHelpPageElement<TData,WorkflowTrigger>

Returns:

The relative path to the help page, e.g. /xwiki/bin/view/Formcycle/Designer/Workflow/Actions/CreateTextFile

getType

default String getType()

Specified by:

getType in interface IWorkflowElementTypeProviding

Returns:

The type of the workflow element that determines how the workflow element behaves. Usually there is a registered handler for each type.

isAvailable

default boolean isAvailable(IIsAvailableParams<TData> params)

Description copied from interface: IElementHandler

Checks whether this workflow element is available to the given client. If this return false, this action cannot be used in the workflow designer. When attempting to execute a workflow with an unavailable action, an error of type NODE_UNAVAILABLE is thrown. The default implementation always returns true.

Specified by:

isAvailable in interface IElementHandler<TData,WorkflowTrigger>

Parameters:

params - The node's data, the entity context, and the current client.

Returns:

Whether the workflow element is available to the given client.

register

default void register()

Description copied from interface: IListenerRegistrator

Invoked by the system and may perform whatever setup logic is required.

Specified by:

register in interface IListenerRegistrator