001: /*
002: * File : $Source: /usr/local/cvs/opencms/src-setup/org/opencms/setup/comptest/CmsSetupTestResult.java,v $
003: * Date : $Date: 2008-02-27 12:05:32 $
004: * Version: $Revision: 1.2 $
005: *
006: * This library is part of OpenCms -
007: * the Open Source Content Management System
008: *
009: * Copyright (c) 2002 - 2008 Alkacon Software GmbH (http://www.alkacon.com)
010: *
011: * This library is free software; you can redistribute it and/or
012: * modify it under the terms of the GNU Lesser General Public
013: * License as published by the Free Software Foundation; either
014: * version 2.1 of the License, or (at your option) any later version.
015: *
016: * This library is distributed in the hope that it will be useful,
017: * but WITHOUT ANY WARRANTY; without even the implied warranty of
018: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
019: * Lesser General Public License for more details.
020: *
021: * For further information about Alkacon Software GmbH, please see the
022: * company website: http://www.alkacon.com
023: *
024: * For further information about OpenCms, please see the
025: * project website: http://www.opencms.org
026: *
027: * You should have received a copy of the GNU Lesser General Public
028: * License along with this library; if not, write to the Free Software
029: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
030: */
031:
032: package org.opencms.setup.comptest;
033:
034: /**
035: * Contains info about the result of a setup test.<p>
036: *
037: * @author Thomas Weckert
038: *
039: * @version $Revision: 1.2 $
040: *
041: * @since 6.0.0
042: */
043: public class CmsSetupTestResult {
044:
045: /** Test passed flag. */
046: private boolean m_green;
047:
048: /** A string offering some help in case a test failed.<p> */
049: private String m_help;
050:
051: /** A info string for the test result.<p> */
052: private String m_info;
053:
054: /** The clear text name of the test.<p> */
055: private String m_name;
056:
057: /** Test failed flag. */
058: private boolean m_red;
059:
060: /** A string describing the result of the test.<p> */
061: private String m_result;
062:
063: /** Test warning flag. */
064: private boolean m_yellow;
065:
066: /**
067: * Creates a new setup test result.<p>
068: *
069: * @param test the test to keep track of
070: */
071: public CmsSetupTestResult(I_CmsSetupTest test) {
072:
073: super ();
074:
075: setGreen();
076: setName(test.getName());
077: setInfo("");
078: setResult("");
079: setHelp("");
080: }
081:
082: /**
083: * Returns the help string what to do if a test failed.<p>
084: * This string will be displayed in a help bubble.<p>
085: *
086: * @return the help string what to do if a test failed
087: */
088: public String getHelp() {
089:
090: return m_help;
091: }
092:
093: /**
094: * Returns the description of the test, e.g. "Test xy failed due to...".<p>
095: *
096: * @return the description of the test
097: */
098: public String getInfo() {
099:
100: return m_info;
101: }
102:
103: /**
104: * Returns the name of the test, e.g. "Operating system test".<p>
105: *
106: * @return the name of the test
107: */
108: public String getName() {
109:
110: return m_name;
111: }
112:
113: /**
114: * Returns the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".<p>
115: *
116: * @return the result of the test
117: */
118: public String getResult() {
119:
120: return m_result;
121: }
122:
123: /**
124: * Returns true, if the conditions the test were fulfilled.<p>
125: *
126: * @return true, if the conditions the test were fulfilled
127: */
128: public boolean isGreen() {
129:
130: return m_green;
131: }
132:
133: /**
134: * Returns true if the test found a violated condition.
135: * It is assumed that it will be impossible to run OpenCms.<p>
136: *
137: * @return true if the test found a violated a condition
138: */
139: public boolean isRed() {
140:
141: return m_red;
142: }
143:
144: /**
145: * Returns true if the test found a questionable condition.
146: * It is possible that OpenCms will not run.<p>
147: *
148: * @return true if the test found a questionable condition
149: */
150: public boolean isYellow() {
151:
152: return m_yellow;
153: }
154:
155: /**
156: * Sets if the conditions in the test were fulfilled.<p>
157: */
158: protected void setGreen() {
159:
160: m_green = true;
161: m_red = false;
162: m_yellow = false;
163: }
164:
165: /**
166: * Sets the help string what to do if a test failed.<p>
167: * This string will be displayed in a help bubble.<p>
168: *
169: * @param help the help string what to do if a test failed
170: */
171: protected void setHelp(String help) {
172:
173: m_help = help;
174: }
175:
176: /**
177: * Sets the description of the test, e.g. "Test xy failed due to...".<p>
178: *
179: * @param info the description of the test
180: */
181: protected void setInfo(String info) {
182:
183: m_info = info;
184: }
185:
186: /**
187: * Sets the name of the test, e.g. "Operating system test".<p>
188: *
189: * @param name the name of the test
190: */
191: protected void setName(String name) {
192:
193: m_name = name;
194: }
195:
196: /**
197: * Sets if the test found a violated condition.<p>
198: */
199: protected void setRed() {
200:
201: m_green = false;
202: m_red = true;
203: m_yellow = false;
204: }
205:
206: /**
207: * Sets the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".<p>
208: *
209: * @param result the result of the test
210: */
211: protected void setResult(String result) {
212:
213: this .m_result = result;
214: }
215:
216: /**
217: * Sets if the test found a questionable condition.<p>
218: */
219: protected void setYellow() {
220:
221: m_green = false;
222: m_red = false;
223: m_yellow = true;
224: }
225: }
|