Package de.xima.fc.gui.common.model.push

Class FacesMessagePushData

java.lang.Object

de.xima.fc.gui.common.model.push.FacesMessagePushData

All Implemented Interfaces:

Serializable

public final class FacesMessagePushData
extends Object
implements Serializable

POJO data model for the push event beans. Represents the data for showing a Faces Message on the client.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
FacesMessagePushData(String summary, String detail, EFacesMessageSeverity severity, boolean saveInSession)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
static FacesMessagePushData	forFacesMessage(javax.faces.application.FacesMessage message)
static FacesMessagePushData	forFacesMessage(javax.faces.application.FacesMessage message, boolean saveInSession)
String	getDetail()
EFacesMessageSeverity	getSeverity()
String	getSummary()
boolean	isSaveInSession()

Methods inherited from class java.lang.Object

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

Constructor Detail

FacesMessagePushData

public FacesMessagePushData(String summary,
                            String detail,
                            EFacesMessageSeverity severity,
                            boolean saveInSession)

Creates a new POJO with the given data.

Parameters:

summary - Value returned by getSummary()

detail - Value returned by getDetail()

severity - Value returned by getSeverity()

saveInSession - Value returned by isSaveInSession()

Method Detail

getDetail

public String getDetail()

Returns:

The detailed message show by the faces message.

getSeverity

public EFacesMessageSeverity getSeverity()

Returns:

The severity of the faces message.

getSummary

public String getSummary()

Returns:

The summary message shown by the faces message.

isSaveInSession

public boolean isSaveInSession()

Returns:

true to save the faces message in the session so that it can be redisplayed when the user reloads the page or navigates to another page (requires an additional AJAX call on the client).

forFacesMessage

public static FacesMessagePushData forFacesMessage(javax.faces.application.FacesMessage message)

Parameters:

message - Faces message to display.

Returns:

New push data for displaying the contents of the given faces message.

forFacesMessage

public static FacesMessagePushData forFacesMessage(javax.faces.application.FacesMessage message,
                                                   boolean saveInSession)

Parameters:

message - Faces message to display.

saveInSession - true to save the faces message in the session so that it can be redisplayed when the user reloads the page or navigates to another page (requires an additional AJAX call on the client).

Returns:

New push data for displaying the contents of the given faces message.