Package de.xima.fc.interfaces.workflow.mixin

Interface IOfficialHelpPageElement<TData,TElement extends IWorkflowElementEntity>

Type Parameters:

TData - Type of the properties model of the node. It is an error to use this mixin with the type parameter set to JSONObject.

TElement - Type of the workflow element, i.e. a node or trigger.

All Superinterfaces:

ICustomParametersUpdateable, IElementHandler<TData,TElement>, IResourceBundleLocator, IWorkflowElementTypeProviding

All Known Subinterfaces:

IBuiltinNodeType<TData>, IBuiltinTriggerType<TData>, IOfficialHelpPageNode<TData>, IOfficialHelpPageTrigger<TData>, ISingleBaseActionBuiltinNodePrototype<TData>, ISingleBaseBuiltinTriggerPrototype<TData>, ISingleBuiltinNodePrototype<TData>, ISingleBuiltinTriggerPrototype<TData>

All Known Implementing Classes:

FcCatchErrorHandler, FcChangeFormAvailabilityHandler, FcChangeFormValueHandler, FcChangeStateHandler, FcCompressAsZipHandler, FcCopyFormRecordHandler, FcCounterHandler, FcCreateTextFileHandler, FcDeleteFormRecordHandler, FcDoiInitHandler, FcDoiVerifiedHandler, FcEmailHandler, FcEmptyHandler, FcExperimentHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcFormSubmitButtonHandler, FcHttpRequestHandler, FcImportFormValueFromXmlHandler, FcInvitationErrorHandler, FcInvitationSentHandler, FcLdapQueryHandler, FcManualHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcProvideResourceHandler, FcQualifiedFormSubmitButtonHandler, FcQueueTaskHandler, FcRedirectHandler, FcRenewProcessIdHandler, FcReturnFileHandler, FcReturnHandler, FcSaveToFileSystemHandler, FcSequenceHandler, FcSetSavedFlagHandler, FcShowTemplateHandler, FcSqlStatementHandler, FcStateTimerHandler, FcThrowExceptionHandler, FcTimePointHandler, FcWriteFormRecordAttrHandler

public interface IOfficialHelpPageElement<TData,TElement extends IWorkflowElementEntity>
extends IElementHandler<TData,TElement>

Mixin that implements IElementHandler.getHelpPageLocation(Locale) by returning a link to the official help pages.

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 IElementHelpLocation	getHelpPageLocation(Locale locale)
String	getOfficialHelpPagePath()

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, getJavaScript, getLocalizedTypeName, getPropertiesBeanClass, getPropertiesViewXhtml, getResourceBundle, getVersion, isAvailable, readEntityReferences, readPlaceholders, validateGlobal, validateLocal, writeEntityReferences, writePlaceholders

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

getType

Method Detail

getHelpPageLocation

default IElementHelpLocation getHelpPageLocation(Locale locale)

Specified by:

getHelpPageLocation in interface IElementHandler<TData,TElement extends IWorkflowElementEntity>

Parameters:

locale - Locale for which the help page was requested.

Returns:

The location of the help page for this element. This is used to show a help link to the user with more details on how they can use the workflow element.

getOfficialHelpPagePath

String getOfficialHelpPagePath()

Returns:

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