Package org.opencms.setup.comptest

Class CmsSetupTestResult

java.lang.Object

org.opencms.setup.comptest.CmsSetupTestResult

public class CmsSetupTestResult
extends Object

Contains info about the result of a setup test.

Since:

6.0.0

Constructor Summary

Constructors

Constructor	Description
CmsSetupTestResult(I_CmsSetupTest test)	Creates a new setup test result.

Method Summary

Modifier and Type	Method	Description
String	getHelp()	Returns the help string what to do if a test failed.
String	getInfo()	Returns the description of the test, e.g.
String	getName()	Returns the name of the test, e.g.
String	getResult()	Returns the result of the test, e.g.
boolean	isGreen()	Returns true, if the conditions the test were fulfilled.
boolean	isRed()	Returns true if the test found a violated condition.
boolean	isYellow()	Returns true if the test found a questionable condition.
protected void	setGreen()	Sets if the conditions in the test were fulfilled.
protected void	setHelp(String help)	Sets the help string what to do if a test failed.
protected void	setInfo(String info)	Sets the description of the test, e.g.
protected void	setName(String name)	Sets the name of the test, e.g.
protected void	setRed()	Sets if the test found a violated condition.
protected void	setResult(String result)	Sets the result of the test, e.g.
protected void	setYellow()	Sets if the test found a questionable condition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CmsSetupTestResult

public CmsSetupTestResult(I_CmsSetupTest test)

Creates a new setup test result.

Parameters:

test - the test to keep track of

Method Details

getHelp

public String getHelp()

Returns the help string what to do if a test failed.

This string will be displayed in a help bubble.

Returns:

the help string what to do if a test failed

getInfo

public String getInfo()

Returns the description of the test, e.g. "Test xy failed due to...".

Returns:

the description of the test

getName

public String getName()

Returns the name of the test, e.g. "Operating system test".

Returns:

the name of the test

getResult

public String getResult()

Returns the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".

Returns:

the result of the test

isGreen

public boolean isGreen()

Returns true, if the conditions the test were fulfilled.

Returns:

true, if the conditions the test were fulfilled

isRed

public boolean isRed()

Returns true if the test found a violated condition. It is assumed that it will be impossible to run OpenCms.

Returns:

true if the test found a violated a condition

isYellow

public boolean isYellow()

Returns true if the test found a questionable condition. It is possible that OpenCms will not run.

Returns:

true if the test found a questionable condition

setGreen

protected void setGreen()

Sets if the conditions in the test were fulfilled.

setHelp

protected void setHelp(String help)

Sets the help string what to do if a test failed.

This string will be displayed in a help bubble.

Parameters:

help - the help string what to do if a test failed

setInfo

protected void setInfo(String info)

Sets the description of the test, e.g. "Test xy failed due to...".

Parameters:

info - the description of the test

setName

protected void setName(String name)

Sets the name of the test, e.g. "Operating system test".

Parameters:

name - the name of the test

setRed

protected void setRed()

Sets if the test found a violated condition.

setResult

protected void setResult(String result)

Sets the result of the test, e.g. "Detected Apache Tomcat/4.1.24...".

Parameters:

result - the result of the test

setYellow

protected void setYellow()

Sets if the test found a questionable condition.