com.plumtree.portalpages.common.areyousure
Class AYSMessage

java.lang.Object
  com.plumtree.portalpages.common.areyousure.AYSMessage

public class AYSMessage
extends java.lang.Object

Author:

adolfoc This simple class encapsulates a single message to be rendered in the AYSMessageView.

Field Summary

static int	AYSTYPE_ACTION
static int	AYSTYPE_ERROR
static int	AYSTYPE_RECOMMENDATION
static int	AYSTYPE_TOPLEVEL Top level messages are printed with now title or descriptive text.
static int	AYSTYPE_WARNING
boolean	m_bHTMLEncode Whether or not this message should be HTMLEncoded when displayed.
int	m_nMessageType The message type for this message.
java.lang.String	m_strMessage The actual message text you would like to print.

Constructor Summary

AYSMessage(java.lang.String strMessage, int nMessageType)
Creates a new AYSMessage object.

AYSMessage(java.lang.String strMessage, int nMessageType, boolean bHTMLEncode)
Creates a new AYSMessage object.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

AYSTYPE_TOPLEVEL

public static final int AYSTYPE_TOPLEVEL

Top level messages are printed with now title or descriptive text. Actions are marked as actions that will occur when the OK button is clicked. Warnings are warnings displayed to the user. Recommendations are marked as suggested actions for the user to take after clicking OK. Errors are errors displayed to the user.

See Also:

Constant Field Values

AYSTYPE_ACTION

public static final int AYSTYPE_ACTION

See Also:

Constant Field Values

AYSTYPE_WARNING

public static final int AYSTYPE_WARNING

See Also:

Constant Field Values

AYSTYPE_RECOMMENDATION

public static final int AYSTYPE_RECOMMENDATION

See Also:

Constant Field Values

AYSTYPE_ERROR

public static final int AYSTYPE_ERROR

See Also:

Constant Field Values

m_strMessage

public java.lang.String m_strMessage

The actual message text you would like to print. This should be localized for display.

m_bHTMLEncode

public boolean m_bHTMLEncode

Whether or not this message should be HTMLEncoded when displayed.

m_nMessageType

public int m_nMessageType

The message type for this message.

Constructor Detail

AYSMessage

public AYSMessage(java.lang.String strMessage,
                  int nMessageType)

Creates a new AYSMessage object.

Parameters:

strMessage -

nMessageType -

AYSMessage

public AYSMessage(java.lang.String strMessage,
                  int nMessageType,
                  boolean bHTMLEncode)

Creates a new AYSMessage object.

Parameters:

strMessage -

nMessageType -

bHTMLEncode -