public interface

WebLocale

implements Persistable
com.microstrategy.web.objects.localization.WebLocale

Class Overview

This interface serves as a wrapper around the Locale object permitting us to define settings such as setResolution(int) that govern the locale resolution workflow in the Intelligence Server.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Public Methods
abstract WebLocale createCopy()
abstract Locale getLocale()
abstract int getResolution()
Resolution scheme to be used for resolving getLocale().
abstract boolean isFeatureAvailable()
Only meaningful when invoked after getSessionID() or resolveLocalesOnly(), otherwise this method will always return true.
abstract void setLocale(Locale newLocale)
Sets a new locale.
abstract void setResolution(int resolution)
[Expand]
Inherited Methods
From interface com.microstrategy.utils.serialization.Persistable

Public Methods

public abstract WebLocale createCopy ()

public abstract Locale getLocale ()

Returns
  • the normalized locale

public abstract int getResolution ()

Resolution scheme to be used for resolving getLocale().

Returns
  • resolution scheme to be used for resolving getLocale().

public abstract boolean isFeatureAvailable ()

Only meaningful when invoked after getSessionID() or resolveLocalesOnly(), otherwise this method will always return true. This returns false if the resolved locale from the Intelligence Server is an LCID of 0 - to enable this feature, please contact Intelligence Server administrator.

Returns
  • whether this feature is enabled.

public abstract void setLocale (Locale newLocale)

Sets a new locale. It also returns the actual normalized locale that is set. Normalization involves converting the Locale instance to a Microsoft LCID then back again to Locale - this ensures we accept only parameters we support, e.g. we do not support language only locales such as fr, which will be normalized to fr_FR that includes the country.

Parameters
newLocale new locale to set
See Also

public abstract void setResolution (int resolution)

Parameters
resolution setting from EnumLocaleResolution