Package de.xima.fc.workflow.mixin

Class APluginTriggerHandler<TData extends BaseTriggerProps>

java.lang.Object

de.xima.fc.workflow.mixin.APluginTriggerHandler<TData>

Type Parameters:

TData - Type of the node's properties model, see IPluginTriggerHandler.

All Implemented Interfaces:

INameProviding, ITransferable, INamedUiElement, IResourceBundleLocator, IElementHandler<TData,WorkflowTrigger>, IRefinedTriggerDataDescriptor<TData>, ITriggerDataDescriptor, ICustomParametersUpdateable, IWorkflowElementTypeProviding, IBeanValidatingElement<TData,WorkflowTrigger>, IBeanValidatingTrigger<TData>, ISingleElementPrototype<TData,WorkflowTrigger>, ISingleTriggerPrototype<TData>, ITriggerHandler<TData>, IWorkflowTriggerTypeProviding, IPluginGenericCustomGUI<IPluginWorkflowTriggerBean>, IFCPlugin, IPluginWorkflowTrigger, IBaseTrigger<TData>, IDefaultClientHandlerTrigger<TData>, IPluginTriggerHandler<TData>, ISingleBaseTriggerPrototype<TData>, Serializable

public abstract class APluginTriggerHandler<TData extends BaseTriggerProps>
extends Object
implements IPluginTriggerHandler<TData>

Abstract base class meant for IPluginWorkflowTrigger plugins that only wish to provide a workflow action that executes some business logic.

Eliminates the last bits of boilerplate code remaining in IPluginTriggerHandler . When you do not need a different super class, you may use this. Otherwise, just implement the mixin IPluginTriggerHandler and add a getter for IPluginTriggerHandler.getPluginInitializeData(). See IPluginTriggerHandler for further details.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

IPluginTriggerHandler, Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

CURRENT_HANDLER_VERSION

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Constructor Summary

Constructors

Constructor	Description
APluginTriggerHandler()

Method Summary

Modifier and Type	Method	Description
IPluginInitializeData	getPluginInitializeData()
void	initialize(IPluginInitializeData initializeData)	Callback method that is invoked when this plugin is initialized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.IBeanValidatingElement

getValidationGroups, validateLocal

Methods inherited from interface de.xima.fc.interfaces.workflow.ICustomParametersUpdateable

updateCustomParams

Methods inherited from interface de.xima.fc.workflow.mixin.IDefaultClientHandlerTrigger

getCascadingStyleSheet, getJavaScript

Methods inherited from interface de.xima.fc.interfaces.workflow.elements.IElementHandler

extractSearchTerms, getCascadingStyleSheet, getDisplayLabel, getElementSummaryModel, getElementSummaryXhtml, getFastJsonConverter, getFilterCriteriaForEntities, getHelpPageLocation, getJavaScript, isAvailable, isHasUserVisibleName, readEntityReferences, readPlaceholders, validateGlobal, writeEntityReferences, writePlaceholders

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Methods inherited from interface de.xima.fc.workflow.mixin.IPluginTriggerHandler

extractDescription, extractName, getDataModelClass, getDescription, getDisplayName, getI18nKeyActionSearchText, getI18nKeyActionSubLabel, getI18nKeyActionTitle, getI18nKeyDescription, getI18nKeyDisplayName, getI18nKeyTriggerLabel, getMainCategory, getMainPluginBeanClass, getName, getPropertiesBeanClass, getPropertiesViewXhtml, getPropertiesViewXhtmlName, getPropertiesViewXhtmlPath, getPrototypeIcon, getPrototypeLabel, getPrototypeSearchText, getPrototypeSubLabel, getPrototypeTitle, getResourceBundle, getResourceBundlePath, getTriggerDataDescriptor, getTriggerHandler, getType, getUnmanagedBeans, getVersion

Methods inherited from interface de.xima.fc.plugin.interfaces.workflow.IPluginWorkflowTrigger

getXhtmlView

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IRefinedTriggerDataDescriptor

getTriggerDataDescriptor, getTriggerFilesDescriptor

Methods inherited from interface de.xima.fc.workflow.mixin.ISingleBaseTriggerPrototype

getPrototypeModelData, getThemeColor

Methods inherited from interface de.xima.fc.interfaces.workflow.mixin.ISingleElementPrototype

getPrototypeSortKey, 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

getTriggerFilesDescriptor

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

getFilterCriteriaForEvent, getLocalizedTypeName, isAppliesToEvent, isPreconditionSatisfied, onTaskBegin, onTaskFinish

Constructor Detail

APluginTriggerHandler

public APluginTriggerHandler()

Method Detail

initialize

public void initialize(IPluginInitializeData initializeData)
                throws FCPluginException

Description copied from interface: IFCPlugin

Callback method that is invoked when this plugin is initialized.

Specified by:

initialize in interface IFCPlugin

Parameters:

initializeData - IPluginInitializeData

Throws:

FCPluginException - May be thrown when an error occurred during the initialization process. When an error is thrown, this plugin will be deactivated and not put into service.

getPluginInitializeData

public IPluginInitializeData getPluginInitializeData()

Specified by:

getPluginInitializeData in interface IPluginTriggerHandler<TData extends BaseTriggerProps>

Returns:

The IPluginInitializeData, as they were passed to IFCPlugin.initialize(IPluginInitializeData). Implementation should usually just store the data in a private volatile field and return it in this method.