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 GmbH & Co. KG, 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.main;
029
030import org.opencms.i18n.CmsMessageContainer;
031
032import java.util.Locale;
033
034/**
035 * Provides localized Exception handling based on the OpenCms default locale.<p>
036 *
037 * Instances of this class are assumed to have full localized exception messages.<p>
038 *
039 * @since 6.0.0
040 */
041public interface I_CmsThrowable {
042
043    /**
044     * Returns a localized exception message based on the OpenCms default locale.<p>
045     *
046     * @return a localized exception message based on the OpenCms default locale
047     * @see Throwable#getLocalizedMessage()
048     */
049    String getLocalizedMessage();
050
051    /**
052     * Returns a localized exception message based on the given Locale.<p>
053     *
054     * @param locale the Locale to get the message for
055     *
056     * @return a localized exception message based on the given Locale
057     */
058    String getLocalizedMessage(Locale locale);
059
060    /**
061     * Returns a localized exception message based on the OpenCms default locale.<p>
062     *
063     * @return a localized exception message based on the OpenCms default locale
064     * @see Throwable#getMessage()
065     */
066    String getMessage();
067
068    /**
069     * Returns the localized message container used to build this localized exception.<p>
070     *
071     * @return the localized message container used to build this localized exception
072     */
073    CmsMessageContainer getMessageContainer();
074}