CmsSetupTestXmlAPI (OpenCms Setup API, version 17.0)

java.lang.Object
- org.opencms.setup.comptest.CmsSetupTestXmlAPI

All Implemented Interfaces:: I_CmsSetupTest

public class CmsSetupTestXmlAPI
extends java.lang.Object
implements I_CmsSetupTest

Test for the XML API.

Since:: 6.1.8

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String TEST_NAME
The test name.
- Fields inherited from interface org.opencms.setup.comptest.I_CmsSetupTest
  RESULT_FAILED, RESULT_PASSED, RESULT_WARNING

Constructor Summary

Constructors
Constructor Description

CmsSetupTestXmlAPI()

Method Summary

All Methods Instance Methods Concrete 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TEST_NAME
```
public static final java.lang.String TEST_NAME
```
    The test name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CmsSetupTestXmlAPI
```
public CmsSetupTestXmlAPI()
```
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: I_CmsSetupTest
    
    Returns the nice name for the test.
    
    Specified by:
    
    getName in interface I_CmsSetupTest
    
    Returns:
    
    the nice name
    
    See Also:
    
    I_CmsSetupTest.getName()
  - execute
```
public CmsSetupTestResult execute(CmsSetupBean setupBean)
                           throws java.lang.Exception
```
    Description copied from interface: I_CmsSetupTest
    
    Returns the test results.
    
    Specified by:
    
    execute in interface I_CmsSetupTest
    
    Parameters:
    
    setupBean - the setup bean
    
    Returns:
    
    the test results
    
    Throws:
    
    java.lang.Exception - if something goes wrong
    
    See Also:
    
    I_CmsSetupTest.execute(org.opencms.setup.CmsSetupBean)