com.taggercat
Class StatusMessage

java.lang.Object
  com.taggercat.StatusMessage

public class StatusMessage
extends java.lang.Object

A general purpose class for recording message information and subsequently including it on a response page. It is set on the request scope under the key: statusMessage. Display the status message using:

<tags:StatusMessages /> Where the StatusMessages tag file may be: <c:if test="${requestScope.statusMessage != null }" > <div class="${requestScope.statusMessage.messageClass}" > <p>${requestScope.statusMessage.caption}</p> <c:if test="${!empty requestScope.statusMessage.messages}" > <p>Message Details:</p> <ul> <c:forEach var="detail" items="${requestScope.statusMessage.messages}"> <li>${detail}</li> </c:forEach> </ul> </c:if> </div> </c:if>

Field Summary

static java.lang.String

messageKey

Constructor Summary

StatusMessage(java.lang.String caption)

StatusMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request)

Method Summary

void	addMessage(java.lang.String message)
static StatusMessage	getAcceptedMessage(java.lang.String caption) Creates an AcceptedMessage; and sets it on the request scope.
static StatusMessage	getAcceptedMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request) Creates an AcceptedMessage; and sets it on the request scope.
java.lang.String	getCaption()
static StatusMessage	getDebugMessage(java.lang.String caption) Creates an Debug Message; and sets it on the request scope.
static StatusMessage	getDebugMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request) Creates an Debug Message; and sets it on the request scope.
static StatusMessage	getErrorMessage(java.lang.String caption) Creates an ActionMessage; and sets it on the request scope.
static StatusMessage	getErrorMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request) Creates an ActionMessage; and sets it on the request scope.
static StatusMessage	getInfoMessage(java.lang.String caption) Creates an ActionMessage; and sets it on the request scope.
static StatusMessage	getInfoMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request) Creates an ActionMessage; and sets it on the request scope.
java.lang.String	getMessageClass()
java.util.List<java.lang.String>	getMessages()
static StatusMessage	getWarnMessage(java.lang.String caption) Creates an ActionMessage; and sets it on the request scope.
static StatusMessage	getWarnMessage(java.lang.String caption, javax.servlet.http.HttpServletRequest request) Creates an ActionMessage; and sets it on the request scope.
void	setCaption(java.lang.String caption)
void	setMessageClass(java.lang.String messageClass)
void	setMessages(java.util.List<java.lang.String> messages)
void	setOnRequest(javax.servlet.http.HttpServletRequest request)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

messageKey

public static final java.lang.String messageKey

See Also:

Constant Field Values

Constructor Detail

StatusMessage

public StatusMessage(java.lang.String caption)

StatusMessage

public StatusMessage(java.lang.String caption,
                     javax.servlet.http.HttpServletRequest request)

Method Detail

getErrorMessage

public static StatusMessage getErrorMessage(java.lang.String caption)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

Returns:

the new instance

getErrorMessage

public static StatusMessage getErrorMessage(java.lang.String caption,
                                            javax.servlet.http.HttpServletRequest request)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

request - the HttpServletRequest object

Returns:

the new instance

getWarnMessage

public static StatusMessage getWarnMessage(java.lang.String caption)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

Returns:

the new instance

getWarnMessage

public static StatusMessage getWarnMessage(java.lang.String caption,
                                           javax.servlet.http.HttpServletRequest request)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

request - the HttpServletRequest object

Returns:

the new instance

getInfoMessage

public static StatusMessage getInfoMessage(java.lang.String caption)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

Returns:

the new instance

getInfoMessage

public static StatusMessage getInfoMessage(java.lang.String caption,
                                           javax.servlet.http.HttpServletRequest request)

Creates an ActionMessage; and sets it on the request scope.

Parameters:

caption - the caption

request - the HttpServletRequest object

Returns:

the new instance

getDebugMessage

public static StatusMessage getDebugMessage(java.lang.String caption)

Creates an Debug Message; and sets it on the request scope.

Parameters:

caption - the caption

Returns:

the new instance

getDebugMessage

public static StatusMessage getDebugMessage(java.lang.String caption,
                                            javax.servlet.http.HttpServletRequest request)

Creates an Debug Message; and sets it on the request scope.

Parameters:

caption - the caption

request - the HttpServletRequest object

Returns:

the new instance

getAcceptedMessage

public static StatusMessage getAcceptedMessage(java.lang.String caption)

Creates an AcceptedMessage; and sets it on the request scope.

Parameters:

caption - the caption

Returns:

the new instance

getAcceptedMessage

public static StatusMessage getAcceptedMessage(java.lang.String caption,
                                               javax.servlet.http.HttpServletRequest request)

Creates an AcceptedMessage; and sets it on the request scope.

Parameters:

caption - the caption

request - the HttpServletRequest object

Returns:

the new instance

setOnRequest

public void setOnRequest(javax.servlet.http.HttpServletRequest request)

getCaption

public java.lang.String getCaption()

setCaption

public void setCaption(java.lang.String caption)

getMessages

public java.util.List<java.lang.String> getMessages()

setMessages

public void setMessages(java.util.List<java.lang.String> messages)

addMessage

public void addMessage(java.lang.String message)

getMessageClass

public java.lang.String getMessageClass()

setMessageClass

public void setMessageClass(java.lang.String messageClass)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object