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.jsp.util;
029
030import org.opencms.i18n.CmsLocaleManager;
031
032import java.util.Locale;
033
034/**
035 * Contains common methods for various beans used to generate the template documentation.
036 */
037public interface I_CmsInfoWrapper {
038
039    /**
040     * Gets the description in the current locale.
041     *
042     * @return the description
043     */
044    String getDescription();
045
046    /**
047     * Gets the description in the given locale.
048     *
049     * @param locale the locale to use
050     * @return the description
051     */
052    String getDescription(Locale locale);
053
054    /**
055     * Gets the description in the given locale.
056     *
057     * @param locale the locale to use
058     * @return the description
059     */
060    default String getDescription(String locale) {
061
062        return getDescription(CmsLocaleManager.getLocale(locale));
063    }
064
065    /**
066     * Returns the localization key for the description if one was used, and null otherwise.
067     *
068     * @return the localization key
069     */
070    String getDescriptionKey();
071
072    /**
073     * Gets the raw description, without resolving any macros.
074     *
075     * @return the raw description
076     */
077    String getDescriptionRaw();
078
079}