Package de.xima.fc.mdl

Class ViewMessage

java.lang.Object

de.xima.fc.mdl.ViewMessage

All Implemented Interfaces:

Serializable

public class ViewMessage
extends Object
implements Serializable

Model representing a message that is to be shown on view initialization. View messages are useful for displaying information to the user after a redirection.

Since:

8.0.0

Author:

XIMA Media GmbH

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ViewMessage.Builder

Method Summary

Modifier and Type	Method	Description
Set<String>	getBlacklistViews()
javax.faces.application.FacesMessage	getFacesMessage()
FCMessage	getFcMessage()
Set<String>	getWhitelistViews()
static ViewMessage.Builder	newBuilder(FCMessage message)
static ViewMessage.Builder	newBuilder(javax.faces.application.FacesMessage message)

Methods inherited from class java.lang.Object

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

Method Details

getFcMessage

public FCMessage getFcMessage()

Returns:

the message in form of an FCMessage.

getFacesMessage

public javax.faces.application.FacesMessage getFacesMessage()

Returns:

the message in form of an FacesMessage.

getWhitelistViews

public Set<String> getWhitelistViews()

Returns:

set of view IDs for which to display the message.

getBlacklistViews

public Set<String> getBlacklistViews()

Returns:

set of view IDs for which NOT to display the message.

newBuilder

public static ViewMessage.Builder newBuilder(FCMessage message)

newBuilder

public static ViewMessage.Builder newBuilder(javax.faces.application.FacesMessage message)