001/*
002 * This library is part of OpenCms -
003 * the Open Source Content Management System
004 *
005 * Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
006 *
007 * This library is free software; you can redistribute it and/or
008 * modify it under the terms of the GNU Lesser General Public
009 * License as published by the Free Software Foundation; either
010 * version 2.1 of the License, or (at your option) any later version.
011 *
012 * This library is distributed in the hope that it will be useful,
013 * but WITHOUT ANY WARRANTY; without even the implied warranty of
014 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015 * Lesser General Public License for more details.
016 *
017 * For further information about Alkacon Software GmbH & Co. KG, please see the
018 * company website: http://www.alkacon.com
019 *
020 * For further information about OpenCms, please see the
021 * project website: http://www.opencms.org
022 *
023 * You should have received a copy of the GNU Lesser General Public
024 * License along with this library; if not, write to the Free Software
025 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
026 */
027
028package org.opencms.setup.comptest;
029
030import org.opencms.setup.CmsSetupBean;
031
032/**
033 * Represent a test to give users infos about whether their system is compatible to OpenCms.<p>
034 *
035 * @since 6.1.8
036 */
037public interface I_CmsSetupTest {
038
039    /** Test failed display text. */
040    String RESULT_FAILED = "failed!";
041
042    /** Test passed display text. */
043    String RESULT_PASSED = "passed";
044
045    /** Test warning display text. */
046    String RESULT_WARNING = "warning!";
047
048    /**
049     * Returns the nice name for the test.<p>
050     *
051     * @return the nice name
052     */
053    String getName();
054
055    /**
056     * Returns the test results.<p>
057     *
058     * @param setupBean the setup bean
059     *
060     * @return the test results
061     *
062     * @throws Exception if something goes wrong
063     */
064    CmsSetupTestResult execute(CmsSetupBean setupBean) throws Exception;
065}