001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyrighted [year] [name of copyright owner]".
013 *
014 *      Copyright 2009 Sun Microsystems, Inc.
015 *      Portions copyright 2011 ForgeRock AS
016 */
017package org.forgerock.i18n;
018
019/**
020 * A mix-in interface which can be used to identify exceptions which support
021 * localization.
022 */
023public interface LocalizableException {
024    /**
025     * Returns the localizable message that explains the problem that occurred.
026     *
027     * @return The localizable message that explains the problem that occurred.
028     */
029    LocalizableMessage getMessageObject();
030
031}