com.ibm.ras
Interface RASIObject

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

RASIFormatter, RASIHandler, RASILogger, RASIMaskChangeGenerator, RASIMessageLogger, RASITraceLogger

All Known Implementing Classes:

RASObject

public interface RASIObject

extends java.io.Serializable

RASIObject defines the methods which are common to the RASILogger, RASIHandler and RASIFormatter interfaces. This interface is intended to be extended by these other interfaces and should not be implemented directly.

Method Summary

java.util.Hashtable	getConfig() Gets the configuration of this object.
java.lang.String	getDescription() Gets the description of this object.
java.lang.String	getGroup() Gets the name of the RASManager group with which this object is associated.
java.lang.String	getName() Gets the name by which this object is known.
void	setConfig(java.util.Hashtable ht) Sets the configuration of this object.
void	setDescription(java.lang.String desc) Sets the description of this object.
void	setName(java.lang.String name) Sets the name by which this object is known.

Method Detail

getConfig

public java.util.Hashtable getConfig()

Gets the configuration of this object.

Returns:

A Hashtable containing the configuration. This object inserts the following key/value pairs into the configuration:

name

The name of the object.

description

The description of the object.

className

The name of the this class.

group

The RAS group of which this object is a member.

All values are Strings. Extensions to this object may add additional keys. (The className and group keys are kept only to maintain the integrity of the configuration. They are used by the RAS Manager.)

setConfig

public void setConfig(java.util.Hashtable ht)

Sets the configuration of this object. This method is used by a RASManager to initialize a RAS object. It should not be necessary for an application to use this method.

Parameters:

ht - A Hashtable containing the configuration. This object searches for the following keys:

name

The name of the object.

description

The description of the object.

className

The name of the this class.

group

The RAS group of which this object is a member.

All values are Strings. If a key is not found, an internal default for that element is set instead. Extensions to this object may use additional keys. (The className and group keys are kept only to maintain the integrity of the configuration. They are used by the RAS Manager.)

getName

public java.lang.String getName()

Gets the name by which this object is known.

Returns:

The name of this object, or an empty string ("") if the name has not been set.

setName

public void setName(java.lang.String name)

Sets the name by which this object is known. If the name is null, the current name is not changed.

Parameters:

name - The name of this object.

getDescription

public java.lang.String getDescription()

Gets the description of this object.

Returns:

The description of this object, or an empty string ("") if the description has not been set.

setDescription

public void setDescription(java.lang.String desc)

Sets the description of this object. If the description is null, the current description is not changed.

Parameters:

desc - The description of this object.

getGroup

public java.lang.String getGroup()

Gets the name of the RASManager group with which this object is associated. (This method is only used by the RAS Manager.)

Returns:

The group name or an empty string if this object is not associated with a group.