Package com.adobe.aemds.guide.service

Interface AdaptiveFormConfigurationService

  • public interface AdaptiveFormConfigurationService

    • Field Detail

      • VISUAL_EDITOR_MODE

        static final java.lang.String VISUAL_EDITOR_MODE
        Constant for specifying default mode of Rule Editor to Visual Editor
        See Also:
        Constant Field Values

      • CODE_EDITOR_MODE

        static final java.lang.String CODE_EDITOR_MODE
        Constant for specifying default mode of Rule Editor to Code Editor
        See Also:
        Constant Field Values

    • Method Detail

      • getShowPlaceholder

        boolean getShowPlaceholder()
        This API returns true when placeholder is to be displayed and false otherwise
        Returns:
        Boolean

      • getRuleEditorDefaultMode

        java.lang.String getRuleEditorDefaultMode()
        Returns the Default Mode when creating rules through Rule Editor. If default mode is {VISUAL_EDITOR_MODE}, then Visual Editor is open when creating rule otherwise Code Editor is opened.
        Returns:
        one of the constants {VISUAL_EDITOR_MODE} or {CODE_EDITOR_MODE} depending upon the default mode set by the user
        Since:
        6.1 FP1

      • isSlingMaxCallValueSmall

        boolean isSlingMaxCallValueSmall()
        Just checks if sling max calls value coming from the sling main servlet is less than our GuideConstants.AF_SLING_MAX_CALL_COUNTER
        Returns:
        true if the system wide value is less than this constant

      • maximumCacheEntries

        int maximumCacheEntries()
        Returns:
        maximum number of Adaptive Forms that will be cached

      • getWSDLConfigSearchPaths

        java.lang.String[] getWSDLConfigSearchPaths()
        Method to return configured search paths
        Returns:
        String[] of all search paths

      • getScriptingCompatibilityMode

        java.lang.String getScriptingCompatibilityMode()
        Returns the version of AEM Forms selected by user for running scripts.
        Returns:
        version of the AEM form selected

      • getMakeFileNamesUnique

        java.lang.Boolean getMakeFileNamesUnique()
        Gives a boolean value weather the file name has to be made unique or not
        Returns:
        true if file names have to be made unique

      • getPreventLiveLinkingFields

        java.lang.Boolean getPreventLiveLinkingFields()
        Indicate whether to prevent live linking of fields with same effective bindref during runtime
        Returns:
        true if live linking of fields is required

      • isGeneratingCompliantData

        java.lang.Boolean isGeneratingCompliantData()
        Indicate whether schema compliant data is to be generated or not.
        Returns:
        true if schema compliant data is to be generated

      • getCustomRuleEditorGroups

        java.lang.String[] getCustomRuleEditorGroups()
        Returns list of configured groups to which rule editor is shown
        Returns:

      • isClientSideMergeSupported

        boolean isClientSideMergeSupported()
        Deprecated.
        Use isClientSideMergeSupported(String) instead, which provides more granular control over which forms have client-side merge enabled through URL pattern matching
        Checks if client-side data merge is globally enabled.
        Returns:
        true if client-side merge is enabled globally

      • isClientSideMergeSupported

        boolean isClientSideMergeSupported​(java.lang.String formPath)
        Checks if client-side data merge is supported for a specific form path. This method first checks if client-side merge is globally enabled via isClientSideMergeSupported(). If enabled and URL patterns are configured, the form path must match one of the patterns. If no patterns are configured, all forms are enabled (due to default regex path, /content/forms/af/.*) for client-side merge.
        Parameters:
        formPath - The path of the form to check
        Returns:
        true if: 1. Client-side merge is enabled globally AND 2. Either: - No URL patterns are manually configured (allowing default paths /content/forms/af) OR - The form path matches one of the configured URL patterns

      • getClientMergeUrlPatterns

        java.lang.String[] getClientMergeUrlPatterns()
        Gets the configured URL patterns that whitelist which forms should have client-side merge enabled. If no patterns are configured, client-side merge is enabled for all forms (when globally enabled).
        Returns:
        Array of regex patterns for URLs where client-side merge is enabled. Default patterns include "/content/forms/af/.*" and "/content/dam/formsanddocuments/.*"

      • isUseBrowserLocale

        boolean isUseBrowserLocale()
        Whether to use browser locale to render form
        Returns:
        true, if UseBrowserLocale flag is set, otherwise false

      • isUseComponentLabelsInExpressionEditor

        boolean isUseComponentLabelsInExpressionEditor()
        Whether to use component labels in expression editor. If false names of the component will be used
        Returns:
        true, if component labels are to be used in expression editor.

      • recaptchaDomain

        java.lang.String recaptchaDomain()
        Domain to be used by recaptcha By default, all recaptcha cloud configurations would use recaptcha.net domain
        Returns:
        String denoting domain to be used for rendering and validating recaptcha

      • getXciPath

        java.lang.String getXciPath()
        XCI file path to be used for DOR generation
        Returns:
        String denoting xci file path which will be used for DOR generation

      • getDocCloudTimeout

        int getDocCloudTimeout()
        timeout for doc merge api for dor generation with docx template
        Returns:
        String timeout