com.adobe.aemds.guide.service.external.FormDataModelService Maven / Gradle / Ivy

Go to download
/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2016 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.external;

import java.util.Map;

import javax.annotation.Nonnull;

/**
 * @pad.exclude Exclude from Published API.
 */
public interface FormDataModelService {
    /**
     * Fetches the list of entities present in the form data model
     * @return JSON array containing the list of entities
     */
    String getFormDataModelJson(String schemaPath);

    /**
     * Fetches the entity id based on the bind ref
     * @param guideContainerPath    path to the adaptive form
     * @param entityBindRef         bind reference/json path to the entity present in the data
     * @return JSON array containing the list of entities
     */
    String getFDMEntityId(String guideContainerPath, String entityBindRef);

    /**
     * Fetches the rule of the entity based on the bindRef
     * @param fdmPath       the path of the fdm
     * @param bindRef       bind reference/json path to the entity present in the data
     * @return Map          containing rules of the entity
     */
    Map getFDMEntityRule(String fdmPath, String bindRef);

    /**
     * Returns data type of given FDM bind reference
     * @param schemaRef
     * @param bindRef
     * @return
     */
    String getFDMDataType(String schemaRef, String bindRef);

    /**
     * Fetches the sample data for the given schema path
     * @param schemaPath    string representing the schema path
     * @return
     */
    @Nonnull String getSampleData(@Nonnull String schemaPath);
}