public interface

Messages

com.microstrategy.web.beans.Messages

Class Overview

The interface encapsulates messages information. The default locale is Locale.US.

Summary

Public Methods
abstract Locale getLocale()
Returns the java.util.Locale object of the current Messages.
abstract String getLocaleId()
Return the locale ID of this messages.
abstract MessagesManager getMessagesManager()
Returns the MessagesManager for this messages.
abstract String getString(String key)
Returns the String descriptor mapped to the specified key.
abstract String[] getStringArray(String key)
Returns an Array of String descriptors mapped by the specified key.
abstract boolean hasString(String key)
Returns whether a String descriptor exists for the specified key.

Public Methods

public abstract Locale getLocale ()

Returns the java.util.Locale object of the current Messages.

Returns
  • the java.util.Locale object.

public abstract String getLocaleId ()

Return the locale ID of this messages.

Returns
  • the locale ID.

public abstract MessagesManager getMessagesManager ()

Returns the MessagesManager for this messages.

Returns
  • the MessagesManager.

public abstract String getString (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.

public abstract String[] getStringArray (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.

public abstract boolean hasString (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.