content: /*
   * This library is part of OpenCms -
   * the Open Source Content Management System
   *
   * Copyright (c) Alkacon Software GmbH & Co. KG (https://www.alkacon.com)
   *
   * This library is free software; you can redistribute it and/or
   * modify it under the terms of the GNU Lesser General Public
   * License as published by the Free Software Foundation; either
   * version 2.1 of the License, or (at your option) any later version.
   *
   * This library is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   * Lesser General Public License for more details.
   *
   * For further information about Alkacon Software GmbH & Co. KG, please see the
   * company website: https://www.alkacon.com
   *
   * For further information about OpenCms, please see the
   * project website: https://www.opencms.org
   *
   * You should have received a copy of the GNU Lesser General Public
   * License along with this library; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
   */
  
  package org.opencms.setup.comptest;
  
  import org.opencms.setup.CmsSetupBean;
  
  /**
   * Represent a test to give users infos about whether their system is compatible to OpenCms.<p>
   *
   * @since 6.1.8
   */
  public interface I_CmsSetupTest {
  
      /** Test failed display text. */
      String RESULT_FAILED = "failed!";
  
      /** Test passed display text. */
      String RESULT_PASSED = "passed";
  
      /** Test warning display text. */
      String RESULT_WARNING = "warning!";
  
      /**
       * Returns the nice name for the test.<p>
       *
       * @return the nice name
       */
      String getName();
  
      /**
       * Returns the test results.<p>
       *
       * @param setupBean the setup bean
       *
       * @return the test results
       *
       * @throws Exception if something goes wrong
       */
      CmsSetupTestResult execute(CmsSetupBean setupBean) throws Exception;
  }