I_CmsThrowable


1   /*
2    * File   : $Source: /usr/local/cvs/opencms/src/org/opencms/main/I_CmsThrowable.java,v $
3    * Date   : $Date: 2005/06/23 11:11:38 $
4    * Version: $Revision: 1.5 $
5    *
6    * This library is part of OpenCms -
7    * the Open Source Content Mananagement System
8    *
9    * Copyright (c) 2005 Alkacon Software GmbH (http://www.alkacon.com)
10   *
11   * This library is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU Lesser General Public
13   * License as published by the Free Software Foundation; either
14   * version 2.1 of the License, or (at your option) any later version.
15   *
16   * This library is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19   * Lesser General Public License for more details.
20   *
21   * For further information about Alkacon Software GmbH, please see the
22   * company website: http://www.alkacon.com
23   *
24   * For further information about OpenCms, please see the
25   * project website: http://www.opencms.org
26   * 
27   * You should have received a copy of the GNU Lesser General Public
28   * License along with this library; if not, write to the Free Software
29   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
30   */
31  
32  package org.opencms.main;
33  
34  import org.opencms.i18n.CmsMessageContainer;
35  
36  import java.util.Locale  ;
37  
38  /**
39   * Provides localized Exception handling based on the OpenCms default locale.<p>
40   * 
41   * Instances of this class are assumed to have full localized exception messages.<p>
42   * 
43   * @author Alexander Kandzior 
44   * 
45   * @version $Revision: 1.5 $ 
46   * 
47   * @since 6.0.0 
48   */
49  public interface I_CmsThrowable {
50  
51      /**
52       * Returns a localized exception message based on the OpenCms default locale.<p>
53       * 
54       * @return a localized exception message based on the OpenCms default locale
55       * @see Throwable#getLocalizedMessage()
56       */
57      String   getLocalizedMessage();
58  
59      /**
60       * Returns a localized exception message based on the given Locale.<p>
61       * 
62       * @param locale the Locale to get the message for
63       * 
64       * @return a localized exception message based on the given Locale
65       */
66      String   getLocalizedMessage(Locale   locale);
67  
68      /**
69       * Returns a localized exception message based on the OpenCms default locale.<p>
70       * 
71       * @return a localized exception message based on the OpenCms default locale
72       * @see Throwable#getMessage()
73       */
74      String   getMessage();
75  
76      /**
77       * Returns the localized message container used to build this localized exception.<p>
78       * 
79       * @return the localized message container used to build this localized exception
80       */
81      CmsMessageContainer getMessageContainer();
82  }
83
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags