I_CmsSetupTest (OpenCms Setup API, version 17.0)

All Known Implementing Classes:

CmsSetupTestFolderPermissions, CmsSetupTestJavaTempDir, CmsSetupTestJdkVersion, CmsSetupTestOperatingSystem, CmsSetupTestServletContainer, CmsSetupTestSimapi, CmsSetupTestWarFileUnpacked, CmsSetupTestXercesVersion, CmsSetupTestXmlAPI
```
public interface I_CmsSetupTest
```
Represent a test to give users infos about whether their system is compatible to OpenCms.

Since:

6.1.8

Field Summary

Fields
Modifier and Type	Field	Description
`static java.lang.String`	`RESULT_FAILED`	Test failed display text.
`static java.lang.String`	`RESULT_PASSED`	Test passed display text.
`static java.lang.String`	`RESULT_WARNING`	Test warning display text.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`CmsSetupTestResult`	`execute(CmsSetupBean setupBean)`	Returns the test results.
`java.lang.String`	`getName()`	Returns the nice name for the test.

- Field Detail
  - RESULT_FAILED
```
static final java.lang.String RESULT_FAILED
```
    Test failed display text.
    
    See Also:
    
    Constant Field Values
  - RESULT_PASSED
```
static final java.lang.String RESULT_PASSED
```
    Test passed display text.
    
    See Also:
    
    Constant Field Values
  - RESULT_WARNING
```
static final java.lang.String RESULT_WARNING
```
    Test warning display text.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the nice name for the test.
    
    Returns:
    
    the nice name
  - execute
```
CmsSetupTestResult execute(CmsSetupBean setupBean)
                    throws java.lang.Exception
```
    Returns the test results.
    
    Parameters:
    
    setupBean - the setup bean
    
    Returns:
    
    the test results
    
    Throws:
    
    java.lang.Exception - if something goes wrong