01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.shared.exceptions;
34:
35: import com.flexive.shared.FxLanguage;
36: import com.flexive.shared.security.UserTicket;
37:
38: /**
39: * Common interface for flexive exceptions.
40: *
41: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
42: */
43: public interface FxLocalizedException {
44: /**
45: * Get the localized message in the default locale (english)
46: *
47: * @return localized message
48: */
49: String getMessage();
50:
51: /**
52: * Get the localized message for a locale
53: *
54: * @param locale locale to get the message got
55: * @return localized message
56: */
57: String getMessage(FxLanguage locale);
58:
59: /**
60: * Get the localized message for a localeId
61: *
62: * @param localeId locale id to get the message for
63: * @return localized message
64: */
65: String getMessage(long localeId);
66:
67: /**
68: * Get the localized message for a calling users locale
69: *
70: * @param ticket calling users ticket, used to get the locale for the message from
71: * @return localized message
72: */
73: String getMessage(UserTicket ticket);
74:
75: /**
76: * Get the underlying exception message object
77: *
78: * @return underlying exception message object
79: */
80: FxExceptionMessage getExceptionMessage();
81: }
|