com.ibm.commerce.ras

Class SystemMessage

java.lang.Object

com.ibm.commerce.ras.SystemMessage

public class SystemMessage
extends java.lang.Object

SystemMessage is the class to handle System type of message.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.

Constructor Summary

Constructors

Constructor and Description
SystemMessage(java.lang.String errorCode, java.lang.String systemText) Constructor for SystemMessage.
SystemMessage(java.lang.String errorCode, java.lang.String systemText, java.lang.String userKey) Constructor for SystemMessage.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSystemErrorCode() Gets the error code of the message.
java.lang.String	getSystemMessage() Gets the system message text.
java.lang.String	getUserMessageKey() Gets the user message key associated to the message.
void	setSysemMessage(java.lang.String message) Sets the system message text.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

Constructor Detail

SystemMessage

public SystemMessage(java.lang.String errorCode,
                     java.lang.String systemText)

Constructor for SystemMessage.

Parameters:

errorCode - the unique message identifier (for example, CMNxxxs)

systemText - the translated message text

SystemMessage

public SystemMessage(java.lang.String errorCode,
                     java.lang.String systemText,
                     java.lang.String userKey)

Constructor for SystemMessage.

Parameters:

errorCode - the unique message identifier. For example, CMNxxxs.

systemText - the translated message text

userKey - the message key for the user message associated to the system message

Method Detail

getSystemErrorCode

public java.lang.String getSystemErrorCode()

Gets the error code of the message.

Returns:

error code which is the unique identifier of the message

getSystemMessage

public java.lang.String getSystemMessage()

Gets the system message text.

Returns:

system message text

getUserMessageKey

public java.lang.String getUserMessageKey()

Gets the user message key associated to the message.

Returns:

user message key associated to the message

setSysemMessage

public void setSysemMessage(java.lang.String message)

Sets the system message text.

Parameters:

message - text string