Package com.microstrategy.web.beans

Interface Messages

  • public interface Messages
    The interface encapsulates messages information. The default locale is Locale.US.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Enumeration<java.lang.String> getKeys()
      Returns an enumeration of the keys.
      java.util.Locale getLocale()
      Returns the java.util.Locale object of the current Messages.
      java.lang.String getLocaleId()
      Return the locale ID of this messages.
      MessagesManager getMessagesManager()
      Returns the MessagesManager for this messages.
      java.lang.String getString​(java.lang.String key)
      Returns the String descriptor mapped to the specified key.
      java.lang.String getString​(java.lang.String key, java.lang.String defultValue)
      Returns the String descriptor mapped to the specified key.
      java.lang.String[] getStringArray​(java.lang.String key)
      Returns an Array of String descriptors mapped by the specified key.
      boolean hasString​(java.lang.String key)
      Returns whether a String descriptor exists for the specified key.

    • Method Detail

      • getString

        java.lang.String getString​(java.lang.String key)
        Returns the String descriptor mapped to the specified key.
        Parameters:
        key - the key of the descriptor.
        Returns:
        the descriptor mapped to the specified key.

      • getString

        java.lang.String getString​(java.lang.String key,
                           java.lang.String defultValue)
        Returns the String descriptor mapped to the specified key.
        Parameters:
        key - the key of the descriptor.
        the - defaultValue for the key
        Returns:
        the descriptor mapped to the specified key.

      • getStringArray

        java.lang.String[] getStringArray​(java.lang.String key)
        Returns an Array of String descriptors mapped by the specified key.
        Parameters:
        key - the key of the descriptor.
        Returns:
        an Array of descriptors mapped to the specified key.

      • getKeys

        java.util.Enumeration<java.lang.String> getKeys()
        Returns an enumeration of the keys.
        Returns:

      • getLocale

        java.util.Locale getLocale()
        Returns the java.util.Locale object of the current Messages.
        Returns:
        the java.util.Locale object.

      • getLocaleId

        java.lang.String getLocaleId()
        Return the locale ID of this messages.
        Returns:
        the locale ID.

      • getMessagesManager

        MessagesManager getMessagesManager()
        Returns the MessagesManager for this messages.
        Returns:
        the MessagesManager.

      • hasString

        boolean hasString​(java.lang.String key)
        Returns whether a String descriptor exists for the specified key.
        Parameters:
        key - The key of the descriptor.
        Returns:
        true if the key has a string descriptor; otherwise false.