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

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

import org.w3c.dom.Document;

import java.util.Map;


/**
 * @pad.exclude Exclude from Published API.
 */
public interface GuideModuleImporter {
    /**
     * Gets resolved/unresolved/summary HTML for the given module asetRef using the Data Dictionary against
     * the document, if the it is a Data Dictionary based Adaptive Form.
     * @param assetRef
     * @param moduleParameter
     * @return String - HTML
     */
    public String getModuleResolution(String assetRef, Map moduleParameter);

    /**
     * Gets resolved/unresolved/summary HTML for the given target area asetRef or module group modules using
     * the Data Dictionary against the document, if the it is a Data Dictionary based adaptive form.
     * @param assetRef
     * @param moduleParameter
     * @return String - HTML
     */
    public String getModuleGroupResolution(String assetRef, Map moduleParameter);

    /**
     *
     * @param data
     * @param moduleParameter
     */
    public void extractVariablesFromData(Document data,Map moduleParameter) throws Exception;

    public boolean canResolveUsingICCData(String path, Map moduleParameter);

    public Map getWebVariableAssignments(Map moduleParameter);
}