Interface IOfficialHelpPageElement<Model, Element extends IWorkflowElementEntity>

Type Parameters:
Model - Type of the properties model of the node. It is an error to use this mixin with the type parameter set to JSONObject.
Element - Type of the workflow element, i.e. a node or trigger.
All Superinterfaces:
ICustomParametersUpdateable, IElementHandler<Model,Element>, 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:
FcBreakHandler, FcCatchErrorHandler, FcChangeFormAvailabilityHandler, FcChangeFormRecordChatActivenessHandler, FcChangeFormValueHandler, FcChangeStateHandler, FcCompressAsZipHandler, FcContinueHandler, FcCopyFormRecordHandler, FcCounterHandler, FcCreateTextFileHandler, FcDecodeBase64Handler, FcDeleteAttachmentHandler, FcDeleteFormRecordHandler, FcDoiInitHandler, FcDoiVerifiedHandler, FcDoUntilLoopHandler, FcEmailHandler, FcEmptyHandler, FcEncodeBase64Handler, FcExperimentHandler, FcExportFormRecordChatsHandler, FcExportToPersistenceHandler, FcExportToXmlHandler, FcFillPdfHandler, FcFillWordHandler, FcForEachLoopHandler, FcFormRecordMessagePostedHandler, FcFormRecordMessageUploadRequestFulfilledHandler, FcFormSubmitButtonHandler, FcHttpRequestHandler, FcImportFormValueFromXmlHandler, FcInvitationErrorHandler, FcInvitationSentHandler, FcLdapQueryHandler, FcLogEntryHandler, FcManualHandler, FcMoveFormRecordToInboxHandler, FcMultipleConditionHandler, FcProcessHistoryPdfHandler, FcProcessLogPdfHandler, FcPromptQueryHandler, FcProvideResourceHandler, FcQualifiedFormSubmitButtonHandler, FcQueueTaskHandler, FcRedirectHandler, FcRenewProcessIdHandler, FcReturnFileHandler, FcReturnHandler, FcSaveToFileSystemHandler, FcSaveToWebDavHandler, FcSendFormRecordMessageHandler, FcSequenceHandler, FcSetFormRecordPasswordHandler, FcSetSavedFlagHandler, FcShowTemplateHandler, FcSqlStatementHandler, FcStateTimerHandler, FcSwitchCaseHandler, FcSwitchDefaultHandler, FcSwitchHandler, FcThrowExceptionHandler, FcTimePointHandler, FcUserInvocationHandler, FcVoidHandler, FcWhileLoopHandler, FcWithFormElementContextHandler, FcWriteFormRecordAttrHandler
public interface IOfficialHelpPageElement<Model, Element extends IWorkflowElementEntity> extends IElementHandler<Model,Element>
Mixin that implements IElementHandler.getHelpPageLocation(Locale) by returning a link to the official help pages.
Since:
7.0.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getHelpPageLocation

      default IElementHelpLocation getHelpPageLocation(Locale locale)
      Specified by:
      getHelpPageLocation in interface IElementHandler<Model, Element 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