001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.gwt;
029
030import java.util.Locale;
031
032import javax.servlet.http.HttpServletRequest;
033
034/**
035 * Convenient client message bundle interface.<p>
036 *
037 * @since 8.0.0
038 *
039 * @see org.opencms.i18n.I_CmsMessageBundle
040 */
041public interface I_CmsClientMessageBundle {
042
043    /**
044     * Returns the JSON code for this resource bundle and the default locale.<p>
045     *
046     * @param request the current request to get the default locale from
047     *
048     * @return the JSON code
049     */
050    String export(HttpServletRequest request);
051
052    /**
053     * Returns the JSON code for this resource bundle and given locale.<p>
054     *
055     * @param locale the locale to export
056     *
057     * @return the JSON code
058     */
059    String export(Locale locale);
060
061    /**
062     * Returns the JSON code for this resource bundle and given locale.<p>
063     *
064     * @param locale the locale to export
065     * @param wrapScript <code>true</code> to wrap the data in a script tag
066     *
067     * @return the JSON code
068     */
069    String export(Locale locale, boolean wrapScript);
070
071    /**
072     * Returns the JSON code for this resource bundle and given locale.<p>
073     *
074     * @param localeName the name of the locale to export
075     *
076     * @return the JSON code
077     */
078    String export(String localeName);
079
080    /**
081     * Returns the bundle name for this OpenCms package.<p>
082     *
083     * @return the bundle name for this OpenCms package
084     */
085    String getBundleName();
086
087    /**
088     * Returns the class of the client implementation.<p>
089     *
090     * @return the class of the client implementation
091     *
092     * @throws Exception if something goes wrong
093     */
094    Class<?> getClientImpl() throws Exception;
095}