01: /*
02: * File : $Source: /usr/local/cvs/opencms/src-setup/org/opencms/setup/comptest/I_CmsSetupTest.java,v $
03: * Date : $Date: 2008-02-27 12:05:32 $
04: * Version: $Revision: 1.2 $
05: *
06: * This library is part of OpenCms -
07: * the Open Source Content Management System
08: *
09: * Copyright (c) 2002 - 2008 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.setup.comptest;
33:
34: import org.opencms.setup.CmsSetupBean;
35:
36: /**
37: * Represent a test to give users infos about whether their system is compatible to OpenCms.<p>
38: *
39: * @author Michael Moossen
40: *
41: * @version $Revision: 1.2 $
42: *
43: * @since 6.1.8
44: */
45: public interface I_CmsSetupTest {
46:
47: /** Test failed display text. */
48: String RESULT_FAILED = "failed!";
49:
50: /** Test passed display text. */
51: String RESULT_PASSED = "passed";
52:
53: /** Test warning display text. */
54: String RESULT_WARNING = "warning!";
55:
56: /**
57: * Returns the nice name for the test.<p>
58: *
59: * @return the nice name
60: */
61: String getName();
62:
63: /**
64: * Returns the test results.<p>
65: *
66: * @param setupBean the setup bean
67: *
68: * @return the test results
69: *
70: * @throws Exception if something goes wrong
71: */
72: CmsSetupTestResult execute(CmsSetupBean setupBean) throws Exception;
73: }
|