edu.internet2.middleware.grouper.ui
Class Message

java.lang.Object
  extended by edu.internet2.middleware.grouper.ui.Message
All Implemented Interfaces:
Serializable

public class Message
extends Object
implements Serializable

A simple message Class which is created for display in the message area of the UI. It is used in conjnction with

Version:
$Id: Message.java,v 1.8 2009-08-12 04:52:14 mchyzer Exp $
Author:
Gary Brown.
See Also:
Serialized Form

Constructor Summary
Message(String message)
          Constructor to ceate a simple message
Message(String message, boolean isError)
          Constructor to create a message which can be an error message
Message(String message, String arg)
          Constructor to create a simple message with a single argument substitution
Message(String message, String[] args)
          Constructor to create a simple message with argument substitution
Message(String message, String[] args, boolean isError)
          Constructor to create a message with argument substitution which can be an error message
Message(String message, String arg, boolean isError)
          Constructor to create a message with single argument substitution which can be an error message
 
Method Summary
static void addVetoMessageToScreen(HttpServletRequest request, HookVeto hookVeto)
          add a veto message to screen.
 String[] getArgs()
           
 String getContainerId()
           
 String getText()
           
 boolean isError()
           
 boolean isWarning()
           
 void setArgs(String[] args)
           
 void setError(boolean isError)
           
 void setText(String message)
           
 void setWarning(boolean isWarning)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Message

public Message(String message)
Constructor to ceate a simple message

Parameters:
message - key in ResourceBundle that returns text

Message

public Message(String message,
               String[] args)
Constructor to create a simple message with argument substitution

Parameters:
message - key in ResourceBundle that returns text
args - values to substitute in format text keyed by message

Message

public Message(String message,
               String arg)
Constructor to create a simple message with a single argument substitution

Parameters:
message - key in ResourceBundle that returns text
arg - value to substitute in format text keyed by message

Message

public Message(String message,
               boolean isError)
Constructor to create a message which can be an error message

Parameters:
message - key in ResourceBundle that returns text
isError - boolean

Message

public Message(String message,
               String arg,
               boolean isError)
Constructor to create a message with single argument substitution which can be an error message

Parameters:
message - key in ResourceBundle that returns text
arg - value to substitute in message
isError - boolean

Message

public Message(String message,
               String[] args,
               boolean isError)
Constructor to create a message with argument substitution which can be an error message

Parameters:
message -
args - values to substitute in message
isError - boolean
Method Detail

getArgs

public String[] getArgs()
Returns:
Returns the args.

setArgs

public void setArgs(String[] args)
Parameters:
args - the args to set.

getContainerId

public String getContainerId()
Returns:
Returns the containerId.

getText

public String getText()
Returns:
Returns the message.

setText

public void setText(String message)
Parameters:
message - the message to set.

isError

public boolean isError()
Returns:
boolean isError.

setError

public void setError(boolean isError)
Parameters:
isError - boolean.

isWarning

public boolean isWarning()
Returns:
boolean isWarning.

setWarning

public void setWarning(boolean isWarning)
Parameters:
isWarning - boolean.

addVetoMessageToScreen

public static void addVetoMessageToScreen(HttpServletRequest request,
                                          HookVeto hookVeto)
add a veto message to screen. Use the key in the veto if available, else use the error message

Parameters:
request -
hookVeto -