KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > util > explorer > swing > gui > api > ValidateReport


1 /*====================================================================
2
3 Objectweb Explorer Framework
4 Copyright (C) 2000-2004 INRIA - USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Jerome Moroy, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.util.explorer.swing.gui.api;
28
29 /**
30  * A ValidateReport is composed of two attribute:
31  * <ul>
32  * <li>A result: TRUE or FALSE to know if the result is OK or not.</li>
33  * <li>A message: To explain why the result is not OK.</li>
34  * </ul>
35  *
36  * @author <a HREF="mailto:Jerome.Moroy@lifl.fr">Jerome Moroy</a>
37  *
38  * @version 0.1
39  */
40 public interface ValidateReport {
41     
42     /**
43      * Fixes the result value.
44      * <ul>
45      * <li>TRUE if the result is OK</li>
46      * <li>FALSE if the result is not OK</li>
47      * </ul>
48      * @param result
49      */
50     public void setResult(boolean result);
51     
52     /**
53      * Gets the result value.
54      * @return The result value
55      */
56     public boolean getResult();
57     
58     /**
59      * Fixes the message to explain why the result is not OK.
60      * @param message An explanation message
61      */
62     public void setMessage(String JavaDoc message);
63     
64     /**
65      * Gets the explanation message
66      * @return The explanation message
67      */
68     public String JavaDoc getMessage();
69     
70 }
Popular Tags