fr.paris.lutece.portal.service.message
Class AdminMessage

java.lang.Object
  extended by fr.paris.lutece.portal.service.message.AdminMessage
All Implemented Interfaces:
Serializable

public class AdminMessage
extends Object
implements Serializable

The class provides a bean to hold message box informations

See Also:
Serialized Form

Field Summary
static int TYPE_CONFIRMATION
           
static int TYPE_ERROR
           
static int TYPE_INFO
           
static int TYPE_QUESTION
           
static int TYPE_STOP
           
static int TYPE_WARNING
           
 
Constructor Summary
AdminMessage(String strTextKey, Object[] messageArgs, String strTitleKey, String strUrl, String strTarget, int nType, boolean bCancelButton)
          Creates a new instance of AppMessage
AdminMessage(String strTextKey, Object[] messageArgs, String strTitleKey, String strUrl, String strTarget, int nType, boolean bCancelButton, Map<String,Object> requestParameters)
          Creates a new instance of AppMessage with request parameters
AdminMessage(String strTextKey, Object[] messageArgs, String strTitleKey, String strUrl, String strTarget, int nType, boolean bCancelButton, Map<String,Object> requestParameters, String strBackUrl)
          Creates a new instance of AppMessage with request parameters
 
Method Summary
 String getBackUrl()
           
 Map<String,Object> getRequestParameters()
          Return the request parameters
 String getTarget()
          Returns the Url of the message box Ok button
 String getText(Locale locale)
          Returns the localized text of the message
 String getTitle(Locale locale)
          Returns the localized text of the message
 int getType()
          Return the type of message
 String getUrl()
          Returns the Url of the message box Ok button
 boolean isCancel()
          Return if the cancel button is display
 void setBackUrl(String strBackUrl)
          set the back url
 void setCancel(boolean bCancel)
          Set the display of cancel button
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_INFO

public static final int TYPE_INFO
See Also:
Constant Field Values

TYPE_QUESTION

public static final int TYPE_QUESTION
See Also:
Constant Field Values

TYPE_ERROR

public static final int TYPE_ERROR
See Also:
Constant Field Values

TYPE_WARNING

public static final int TYPE_WARNING
See Also:
Constant Field Values

TYPE_CONFIRMATION

public static final int TYPE_CONFIRMATION
See Also:
Constant Field Values

TYPE_STOP

public static final int TYPE_STOP
See Also:
Constant Field Values
Constructor Detail

AdminMessage

public AdminMessage(String strTextKey,
                    Object[] messageArgs,
                    String strTitleKey,
                    String strUrl,
                    String strTarget,
                    int nType,
                    boolean bCancelButton)
Creates a new instance of AppMessage

Parameters:
strTextKey - The message Key
strUrl - The default Button URL
messageArgs - The message arguments
strTitleKey - The Title key
strTarget - The target
nType - The message Type
bCancelButton - Add a Cancel Button

AdminMessage

public AdminMessage(String strTextKey,
                    Object[] messageArgs,
                    String strTitleKey,
                    String strUrl,
                    String strTarget,
                    int nType,
                    boolean bCancelButton,
                    Map<String,Object> requestParameters)
Creates a new instance of AppMessage with request parameters

Parameters:
strTextKey - The message Key
strUrl - The default Button URL
messageArgs - The message arguments
strTitleKey - The Title key
strTarget - The target
nType - The message Type
bCancelButton - Add a Cancel Button
requestParameters - The Request parameters in a map

AdminMessage

public AdminMessage(String strTextKey,
                    Object[] messageArgs,
                    String strTitleKey,
                    String strUrl,
                    String strTarget,
                    int nType,
                    boolean bCancelButton,
                    Map<String,Object> requestParameters,
                    String strBackUrl)
Creates a new instance of AppMessage with request parameters

Parameters:
strTextKey - The message Key
strUrl - The default Button URL
messageArgs - The message arguments
strTitleKey - The Title key
strTarget - The target
nType - The message Type
bCancelButton - Add a Cancel Button
requestParameters - The Request parameters in a map
strBackUrl - the back url
Method Detail

getType

public int getType()
Return the type of message

Returns:
the type message

isCancel

public boolean isCancel()
Return if the cancel button is display

Returns:
true if the cancel button is display

setCancel

public void setCancel(boolean bCancel)
Set the display of cancel button

Parameters:
bCancel - the new bCancel

getText

public String getText(Locale locale)
Returns the localized text of the message

Parameters:
locale - The current locale
Returns:
The localized text of the message

getTitle

public String getTitle(Locale locale)
Returns the localized text of the message

Parameters:
locale - The current locale
Returns:
The localized text of the message

getUrl

public String getUrl()
Returns the Url of the message box Ok button

Returns:
the Url of the Ok button

getTarget

public String getTarget()
Returns the Url of the message box Ok button

Returns:
the Url of the Ok button

getRequestParameters

public Map<String,Object> getRequestParameters()
Return the request parameters

Returns:
the request parameters

setBackUrl

public void setBackUrl(String strBackUrl)
set the back url

Parameters:
strBackUrl - the back url

getBackUrl

public String getBackUrl()
Returns:
back url


Copyright © 2014 Mairie de Paris. All Rights Reserved.