Package org.kuali.rice.krad.util

Class GrowlMessage

java.lang.Object
org.kuali.rice.krad.util.GrowlMessage
All Implemented Interfaces:
Serializable
public class GrowlMessage extends Object implements Serializable
Contains configuration for displaying a growl message
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • GrowlMessage

      public GrowlMessage()

  • Method Details

    • getNamespaceCode

      public String getNamespaceCode()
      Namespace code (often an application or module code) the growl message is associated with

      Used with the component code and message key for retrieving the message text (and title text). If null, the default namespace code will be used

      Returns:
      String error namespace code

    • setNamespaceCode

      public void setNamespaceCode(String namespaceCode)
      Setter for the growl's associated namespace code
      Parameters:
      namespaceCode -

    • getComponentCode

      public String getComponentCode()
      A code within the namespace that identifies a component or group the growl message is associated with

      Used with the namespace and message key for retrieving the message text (and title text). If null, the default component code will be used

      Returns:
      String component code

    • setComponentCode

      public void setComponentCode(String componentCode)
      Setter for the growl's associated component code
      Parameters:
      componentCode -

    • getTitle

      public String getTitle()
      Title for growl message (displays on top bar of growl)
      Returns:
      String title text

    • setTitle

      public void setTitle(String title)
      Setter for the growl title
      Parameters:
      title -

    • getTitleKey

      public String getTitleKey()
      Key for the title message within the message repository

      Growl title text can be externalized into a message repository (see org.kuali.rice.krad.messages.MessageService. This gives the key for which the message which is used with the namespace and component to retrieve the message text

      Returns:
      String message key

    • setTitleKey

      public void setTitleKey(String titleKey)
      Setter for the growl title message key
      Parameters:
      titleKey -

    • getMessageKey

      public String getMessageKey()
      Key for the growl message within the message repository

      Growl message text must be externalized into a message repository (see org.kuali.rice.krad.messages.MessageService. This gives the key for which the message which is used with the namespace and component to retrieve the message text

      Returns:
      String message key

    • setMessageKey

      public void setMessageKey(String messageKey)
      Setter for the growl message key
      Parameters:
      messageKey -

    • getMessageParameters

      public String[] getMessageParameters()
      One or more parameters for complete the growl message

      An externally defined message can contain one or more placeholders which will get completed from runtime variables. This array of strings is used for completing the message. The message parameters are filled based on the order or parameters within the array

      Returns:
      String[] array of string values to fill message parameters

    • setMessageParameters

      public void setMessageParameters(String[] messageParameters)
      Setter for the message parameters array
      Parameters:
      messageParameters -

    • getTheme

      public String getTheme()
      Name of the growl theme to use (must be setup through the view growl property
      Returns:
      String name of growl theme

    • setTheme

      public void setTheme(String theme)
      Setter for the growl theme to use
      Parameters:
      theme -