NotificationBean (formcycle: bom 8.0.4-RC.3 API)

java.lang.Object
- de.xima.fc.gui.common.utils.msg.I18nUtils
- - de.xima.fc.gui.common.utils.msg.MessageUtils
  - - de.xima.fc.gui.common.utils.msg.AMessaging
    - - de.xima.fc.gui.common.utils.msg.AJSFContext
      - de.xima.fc.gui.common.bean.NotificationBean

All Implemented Interfaces:

Serializable
```
@Named
@SessionScoped
public class NotificationBean
extends AJSFContext
```
Bean that stores all faces messages that should be redisplayed in the notification history to the top right.
Also checks messages targeted at a specific client ID and displays those messages as a global growl if certain criteria are met.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext
  AJSFContext.RedirectOptions, AJSFContext.RedirectOptionsBuilder

Field Summary
- Fields inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext
  localeBean

Constructor Summary

Constructors
Constructor Description

NotificationBean()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addSessionMessage()`	Saves the given message in the session.
`void`	`addSessionMessages(List<? extends TargettedFacesMessage> messages)`	Saves the given FacesMessages in the session.
`List<SessionFacesMessage>`	`getSessionFacesMessages()`
`String`	`getSessionFacesMessagesJson()`
`void`	`onMessages(MessageListenerEvent event)`	Callback for `MessageListener` component that saves the given FacesMessages in the session.
`javax.faces.application.FacesMessage`	`transformMessage(MessageListenerTransformParams params)`	Transforms messages.

Methods inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext
destroySessionBean, encodeURL, findBean, findBean, findBean, findBean, findBean, findBean, findBean, findCurrentView, findUserContext, getBeanName, getBeanName, getContext, getCurrentViewBean, getLocaleBean, getRequest, getResponse, getSession, getSession, getSessionAttribute, isMasterServerContext, loadLazy, redirect, redirect, redirect, redirect, redirectToDashboard, redirectToDashboard, redirectToDashboard, setLocaleBean, setSessionAttribute, uc

Methods inherited from class de.xima.fc.gui.common.utils.msg.MessageUtils
addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsgFromString, addErrorMsgFromString, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsgFromString, addInfoMsgFromString, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addMsg, addMsg, addMsg, addMsg, addMsgs, addMsgs, addMsgToComponent, addMsgToComponent, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsgFromString, addWarnMsgFromString, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, cleanErrorMsg, errorMsg, errorMsg, getErrorMessage, getNewErrorMsg, getNewErrorMsg, getNewErrorMsg, getNewInfoMsg, getNewInfoMsg, getNewMsg, getNewWarnMsg, getNewWarnMsg, msg

Methods inherited from class de.xima.fc.gui.common.utils.msg.I18nUtils
getFacesContext, getLocale, rbValue, rbValue, rbValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NotificationBean
```
public NotificationBean()
```
- Method Detail
  - addSessionMessage
```
public void addSessionMessage()
```
    Saves the given message in the session.
  - addSessionMessages
```
public void addSessionMessages(List<? extends TargettedFacesMessage> messages)
```
    Saves the given FacesMessages in the session.
    
    Parameters:
    
    messages - Message to be saved.
  - getSessionFacesMessages
```
public List<SessionFacesMessage> getSessionFacesMessages()
```
    Returns:
    
    A list of messages currently saved in the session.
  - getSessionFacesMessagesJson
```
public String getSessionFacesMessagesJson()
```
    Returns:
    
    A list of messages currently saved in the session, serialized as a JSON array.
  - onMessages
```
public void onMessages(MessageListenerEvent event)
```
    Callback for MessageListener component that saves the given FacesMessages in the session.
    
    Parameters:
    
    event - Message event that occurred.
  - transformMessage
```
public javax.faces.application.FacesMessage transformMessage(MessageListenerTransformParams params)
```
    Transforms messages. For file uploads, shows the general warning when there is a validation error.
    
    Parameters:
    
    params - Parameters with the message to transform.
    
    Returns:
    
    The transformed message.