com.adobe.aemds.guide.service.AdaptiveFormConfigurationService Maven / Gradle / Ivy

Go to download
/*
 * **********************************************************************
 *  ADOBE CONFIDENTIAL
 *  __________________
 *
 *  Copyright 2015 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 *  NOTICE:  All information contained herein is, and remains
 *  the property of Adobe Systems Incorporated and its suppliers,
 *  if any.  The intellectual and technical concepts contained
 *  herein are proprietary to Adobe Systems Incorporated and its
 *  suppliers and may be covered by U.S. and Foreign Patents,
 *  patents in process, and are protected by trade secret or copyright law.
 *  Dissemination of this information or reproduction of this material
 *  is strictly forbidden unless prior written permission is obtained
 *  from Adobe Systems Incorporated.
 *  **********************************************************************
 */
package com.adobe.aemds.guide.service;

/**
 * @pad.exclude Exclude from Published API.
 */
public interface AdaptiveFormConfigurationService {

    /**
     * Constant for specifying default mode of Rule Editor to Visual Editor
     */
    public final static String VISUAL_EDITOR_MODE = "1";
    /**
     * Constant for specifying default mode of Rule Editor to Code Editor
     */
    public final static String CODE_EDITOR_MODE = "2";

    /**
     * This API returns true when placeholder is to be displayed and false otherwise
     * @return Boolean
     * @public
     */
    public boolean getShowPlaceholder();

    /**
     * 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.
     * @return one of the constants {VISUAL_EDITOR_MODE} or {CODE_EDITOR_MODE} depending upon the default mode set by
     *         the user
     * @since 6.1 FP1
     */
    public String getRuleEditorDefaultMode();

    /**
     * @pad.exclude Exclude from Published API.
     */

    /**
     *  Just checks if sling max calls value coming from the
     *  sling main servlet is less than our {@link
     *  com.adobe.aemds.guide.utils.GuideConstants#AF_SLING_MAX_CALL_COUNTER}
     * @return true if the system wide value is less than this constant
     */
    public boolean isSlingMaxCallValueSmall();

    /**
     *
     * @return maximum number of Adaptive Forms that will be cached
     */
    public int maximumCacheEntries();

    /**
     * Method to return configured search paths
     * @return String[] of all search paths
     */
    public String [] getWSDLConfigSearchPaths();

    /**
     * Returns the version of AEM Forms selected by user for running scripts.
     * @return version of the AEM form selected
     */
    public String getScriptingCompatibilityMode();

    /**
     *  Gives a boolean value weather the file name has to be made unique or not
     * @return true if file names have to be made unique
     */
    public Boolean getMakeFileNamesUnique();

    /**
     * Indicate whether to prevent live linking of fields with same effective bindref during runtime
     * @return true if live linking of fields is required
     */
    public Boolean getPreventLiveLinkingFields();

    /**
     * Indicate whether schema compliant data is to be generated or not.
     * @return true if schema compliant data is to be generated
     */
    public Boolean isGeneratingCompliantData();


    /**
     * Returns list of configured groups to which
     * rule editor is shown
     * @return
     */
    public String [] getCustomRuleEditorGroups();
}