net.openwings.availability
Class UnitReport

java.lang.Object
  |
  +--net.openwings.availability.UnitReport

All Implemented Interfaces:

java.io.Serializable

public class UnitReport

extends java.lang.Object

implements java.io.Serializable

This class is used to report a fault in a unit (a component or a specific capability provided by a component).

See Also:

Serialized Form

Field Summary

static int	OFFLINE This constant is used to indicate that a unit is unavailable.
static int	ONLINE This constant is used to indicate that a unit is available.

Constructor Summary

UnitReport(java.lang.String name, java.lang.String description, int status, boolean degraded)
This is the single public constructor for this class.

Method Summary

boolean	getDegraded() This method is used to get the degraded status.
java.lang.String	getDescription() This method is used to get the desription of the fault.
java.lang.String	getName() This method is used to get the name of the unit under test.
int	getStatus() This method is used to get the status of this unit.

Methods inherited from class java.lang.Object

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

Field Detail

OFFLINE

public static final int OFFLINE

This constant is used to indicate that a unit is unavailable.

See Also:

Constant Field Values

ONLINE

public static final int ONLINE

This constant is used to indicate that a unit is available.

See Also:

Constant Field Values

Constructor Detail

UnitReport

public UnitReport(java.lang.String name,
                  java.lang.String description,
                  int status,
                  boolean degraded)

This is the single public constructor for this class.

Parameters:

name - the name of the unit under test.

description - the description of the fault.

status - the OFFLINE, ONLINE status indicator.

degraded - boolean indicating if the unit's capability is degraded.

Method Detail

getStatus

public int getStatus()

This method is used to get the status of this unit.

Returns:

the status of the unit under test: OFFLINE, ONLINE

getName

public java.lang.String getName()

This method is used to get the name of the unit under test.

Returns:

the name of the unit

getDescription

public java.lang.String getDescription()

This method is used to get the desription of the fault.

Returns:

the fault description

getDegraded

public boolean getDegraded()

This method is used to get the degraded status.

Returns:

true if degraded