Package com.microstrategy.web.objects.localization

Interface WebLocale

  • All Superinterfaces:
    EnumWebPersistableState, Persistable
    public interface WebLocale
extends Persistable
    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.
    Since:
    MicroStrategy Web 9.0.0

    • Method Detail

      • getLocale

        java.util.Locale getLocale()
        Returns:
        the normalized locale
        See Also:
        setLocale(Locale)

      • setLocale

        void setLocale​(java.util.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:
        getLocale()

      • setResolution

        void setResolution​(int resolution)
        Parameters:
        resolution - setting from EnumLocaleResolution

      • getResolution

        int getResolution()
        Resolution scheme to be used for resolving getLocale().
        Returns:
        resolution scheme to be used for resolving getLocale().

      • isFeatureAvailable

        boolean isFeatureAvailable()
        Only meaningful when invoked after WebSessionInfo.getSessionID() or WebIServerSession.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.