com.adobe.aemds.guide.service.GuideLocalizationService 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.apache.sling.api.resource.Resource;
import org.apache.sling.commons.json.JSONObject;

import java.util.List;
import java.util.Map;

/**
 * @pad.exclude Exclude from Published API.
 */
public interface GuideLocalizationService {
    /**
     * Creates dictionary nodes for a guide container resource.
     * @param guideContainerResource The guide container resource for which the dictionary is to be created.
     */
    public void createDictionary(Resource guideContainerResource) throws GuideException;

    /**
     * Updates dictionary nodes to reflect the current guide container resource path in the base name.
     * @param guideContainerResource The guide container resource for which the dictionary is to be updated.
     */
    public void updateDictionaryBaseName(Resource guideContainerResource) throws GuideException;

    /**
     * Get Map of code and title of supported locales
     * @return map containing locale specific title
     */
    public Map getLocaleTitleCodeMap();

        /**
         * Get a list of supported locales.
         * @return A string array of supported locales
         */
    public String[] getSupportedLocales();

    /**
     * Create a dictionary with  all the referencing Adaptive Forms Fragments included as well
     * This would create dictionary for all the  locales in {@link GuideLocalizationService}
     * @param containerResource
     * @throws GuideException
     */
    public JSONObject createDictionaryWithFragmentContent(Resource containerResource) throws  GuideException;

    /**
     * Create a dictionary with  all the referencing Adaptive Forms Fragments included as well
     * for the list of locales provided
     * @param containerResource
     * @param localeList
     * @throws GuideException
     */
    public JSONObject createDictionaryWithFragmentContent(Resource containerResource, List localeList) throws GuideException;

    /**
     *  Create a dictionary with  all the referencing Adaptive Forms Fragments included as well
     * for the locale provided
     * @param containerResource
     * @param locale
     * @throws GuideException
     */

    public JSONObject createDictionaryWithFragmentContent(Resource containerResource, String locale) throws GuideException;

    /**
     * Get language codes for all the available dictionaries
     * @param containerResource
     * @throws GuideException
     */
    public JSONObject getAvailableLocales(Resource containerResource) throws GuideException;

    }