com.tivoli.pd.jutil
Class PDMessage

java.lang.Object
  com.tivoli.pd.jutil.PDMessage

All Implemented Interfaces:

java.lang.Cloneable

public class PDMessage
extends java.lang.Object
implements java.lang.Cloneable

This class stores the message code, localized string, and severity for a single PD Message.

Modes: Local,Remote

Field Summary

static int	PDMESSAGE_SEVERITY_ERROR Represents the error severity level for a PD Message.
static int	PDMESSAGE_SEVERITY_INFO Represents the information severity level for a PD Message.
static int	PDMESSAGE_SEVERITY_WARNING Represents the warning severity level for a PD Message.

Constructor Summary

PDMessage(int inMsgCode, java.util.Locale locale)
Constructs a PDMessage with the specified code and locale.

PDMessage(int inMsgCode, java.util.Locale locale, java.lang.Object[] args)
Constructs a PDMessage with the specified code, locale and arguments.

PDMessage(int inMsgCode, java.lang.String inMsgText, long inMsgSeverity)
Constructs a PDMessage with the specified code, text, and severity.

PDMessage(int inMsgCode, java.lang.String inMsgText, long inMsgSeverity, java.lang.Object[] inArgs)
Constructs a PDMessage with the specified code, text, severity and arguments.

Method Summary

java.lang.Object	clone() Returns a copy of this object.
java.lang.String[]	getMsgArgs() Returns the arguments for the message.
int	getMsgCode() Returns the code for the message.
long	getMsgSeverity() Returns the severity for the message.
java.lang.String	getMsgText() Returns the localized text for the message.
java.lang.String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

PDMESSAGE_SEVERITY_INFO

public static final int PDMESSAGE_SEVERITY_INFO

Represents the information severity level for a PD Message.

See Also:

Constant Field Values

PDMESSAGE_SEVERITY_WARNING

public static final int PDMESSAGE_SEVERITY_WARNING

Represents the warning severity level for a PD Message.

See Also:

Constant Field Values

PDMESSAGE_SEVERITY_ERROR

public static final int PDMESSAGE_SEVERITY_ERROR

Represents the error severity level for a PD Message.

See Also:

Constant Field Values

Constructor Detail

PDMessage

public PDMessage(int inMsgCode,
                 java.lang.String inMsgText,
                 long inMsgSeverity)

Constructs a PDMessage with the specified code, text, and severity.

Parameters:

inMsgCode - Code for this message.

inMsgText - Localized text for this message.

inMsgSeverity - Severity for this message.

PDMessage

public PDMessage(int inMsgCode,
                 java.lang.String inMsgText,
                 long inMsgSeverity,
                 java.lang.Object[] inArgs)

Constructs a PDMessage with the specified code, text, severity and arguments.

Parameters:

inMsgCode - Code for this message.

inMsgText - Localized text for this message.

inMsgSeverity - Severity for this message.

inArgs - Arguments for this message. Pass in null if there are no arguments.

PDMessage

public PDMessage(int inMsgCode,
                 java.util.Locale locale)

Constructs a PDMessage with the specified code and locale.

Parameters:

inMsgCode - Code for this message.

locale - Locale for any data that is returned.

PDMessage

public PDMessage(int inMsgCode,
                 java.util.Locale locale,
                 java.lang.Object[] args)

Constructs a PDMessage with the specified code, locale and arguments.

Parameters:

inMsgCode - Code for this message.

locale - Locale for any data that is returned.

args - Arguments for the message. Pass in null if there are no arguments.

Method Detail

getMsgCode

public int getMsgCode()

Returns the code for the message.

Returns:

the message code for this PD message.

getMsgText

public java.lang.String getMsgText()

Returns the localized text for the message.

Returns:

the localized text for this PD message.

getMsgSeverity

public long getMsgSeverity()

Returns the severity for the message.

Returns:

the message severity for this PD message.

getMsgArgs

public java.lang.String[] getMsgArgs()

Returns the arguments for the message.

Returns:

the message arguments for this PD message.

toString

public java.lang.String toString()

Returns a string representation of this object.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Returns a copy of this object.

Overrides:

clone in class java.lang.Object