org.vfny.geoserver.control
Interface IStatusReport

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultStatusReport

public interface IStatusReport
extends java.io.Serializable

An IStatusReport represents the results of querying a module regarding its status. It contains information regarding the modules status, represented by the three static constants OKAY, WARNING, and ERROR. It also contains an associated message and an identifier that can be used to trace this report back to the module. Because IStatusReports are intended to be sent over remote channels, they must all be Serializable.

Author:

Richard Gould

Field Summary

static int	ERROR Indicates that something is wrong with the module and it is not functioning.
static int	OKAY Indicates that everything is working properly in the intended module.
static int	WARNING Indicates that something is potentially wrong in the module, but this is not a fatal problem.

Method Summary

java.lang.Exception	getMessage() Message is an Exception containing a message or a stack trace relevant to the current status.
java.lang.String	getModuleName() The module name is a human readable String used to identify this module.
int	getStatus() Status can be one of the three static constants OKAY, WARNING or ERROR.

Field Detail

OKAY

static final int OKAY

Indicates that everything is working properly in the intended module. A message is not usually associated with this status.

See Also:

Constant Field Values

WARNING

static final int WARNING

Indicates that something is potentially wrong in the module, but this is not a fatal problem. A message about the problem could be retrieved using getMessage().

See Also:

Constant Field Values

ERROR

static final int ERROR

Indicates that something is wrong with the module and it is not functioning. A message about the problem should be available by calling getMessage().

See Also:

Constant Field Values

Method Detail

getModuleName

java.lang.String getModuleName()

The module name is a human readable String used to identify this module.

Returns:

the name of the module that this report is based upon.

getMessage

java.lang.Exception getMessage()

Message is an Exception containing a message or a stack trace relevant to the current status. Message could be null, for instance if status was OKAY.

Returns:

a message from the module relevant to the status

getStatus

int getStatus()

Status can be one of the three static constants OKAY, WARNING or ERROR.

Returns:

the status indicator of the module that this report is based upon