org.rcfaces.core.model
Class ClientFacesMessage

java.lang.Object
  extended by javax.faces.application.FacesMessage
      extended by org.rcfaces.core.model.ClientFacesMessage
All Implemented Interfaces:
Serializable, IClientDataCapability

public class ClientFacesMessage
extends FacesMessage
implements IClientDataCapability

Version:
$Revision: 1.1 $ $Date: 2007/05/04 14:40:33 $
Author:
Olivier Oeuillot (latest modification by $Author: oeuillot $)
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.faces.application.FacesMessage
FacesMessage.Severity
 
Field Summary
 
Fields inherited from class javax.faces.application.FacesMessage
FACES_MESSAGES, SEVERITY_ERROR, SEVERITY_FATAL, SEVERITY_INFO, SEVERITY_WARN, VALUES, VALUES_MAP
 
Constructor Summary
ClientFacesMessage()
           
ClientFacesMessage(FacesMessage.Severity severity, String summary, String detail)
           
ClientFacesMessage(String summary)
           
ClientFacesMessage(String summary, String detail)
           
 
Method Summary
 String getClientData(String name)
          Retrieves the data associated to a variable
 int getClientDataCount()
          Returns the number of variable associated to the component.
 Map getClientDataMap()
          Returns a map containing the couples variable-data
 String[] listClientDataKeys()
          Returns the list of variable associated to the component.
 String removeClientData(String name)
          Removes the variable name and the data associated to it
 String setClientData(String name, String data)
          Associates data to variable name.
 
Methods inherited from class javax.faces.application.FacesMessage
getDetail, getSeverity, getSummary, setDetail, setSeverity, setSummary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientFacesMessage

public ClientFacesMessage()

ClientFacesMessage

public ClientFacesMessage(FacesMessage.Severity severity,
                          String summary,
                          String detail)

ClientFacesMessage

public ClientFacesMessage(String summary,
                          String detail)

ClientFacesMessage

public ClientFacesMessage(String summary)
Method Detail

getClientData

public String getClientData(String name)
Description copied from interface: IClientDataCapability
Retrieves the data associated to a variable

Specified by:
getClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
Returns:
the data associated to the variable

getClientDataCount

public int getClientDataCount()
Description copied from interface: IClientDataCapability
Returns the number of variable associated to the component.

Specified by:
getClientDataCount in interface IClientDataCapability
Returns:
number of variable

getClientDataMap

public Map getClientDataMap()
Description copied from interface: IClientDataCapability
Returns a map containing the couples variable-data

Specified by:
getClientDataMap in interface IClientDataCapability
Returns:
a map

listClientDataKeys

public String[] listClientDataKeys()
Description copied from interface: IClientDataCapability
Returns the list of variable associated to the component.

Specified by:
listClientDataKeys in interface IClientDataCapability
Returns:
a list of variables

removeClientData

public String removeClientData(String name)
Description copied from interface: IClientDataCapability
Removes the variable name and the data associated to it

Specified by:
removeClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
Returns:
the data that was associated to the variable

setClientData

public String setClientData(String name,
                            String data)
Description copied from interface: IClientDataCapability
Associates data to variable name.

Specified by:
setClientData in interface IClientDataCapability
Parameters:
name - the variable to associate data to
data - the data to associate to the variable
Returns:
the data previously associated with the variable (empty if none)


Copyright © 2006-2011 Vedana. All Rights Reserved.