Interface WebLocale
-
- All Superinterfaces:
EnumWebPersistableState
,Persistable
public interface WebLocale extends Persistable
This interface serves as a wrapper around theLocale
object permitting us to define settings such assetResolution(int)
that govern the locale resolution workflow in the Intelligence Server.- Since:
- MicroStrategy Web 9.0.0
-
-
Field Summary
-
Fields inherited from interface com.microstrategy.utils.serialization.EnumWebPersistableState
BARE_MINIMAL_STATE_INFO, MAXIMAL_STATE_INFO, MINIMAL_STATE_INFO, TYPICAL_STATE_INFO
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description WebLocale
createCopy()
java.util.Locale
getLocale()
int
getResolution()
Resolution scheme to be used for resolvinggetLocale()
.boolean
isFeatureAvailable()
Only meaningful when invoked afterWebSessionInfo.getSessionID()
orWebIServerSession.resolveLocalesOnly()
, otherwise this method will always return true.void
setLocale(java.util.Locale newLocale)
Sets a new locale.void
setResolution(int resolution)
-
Methods inherited from interface com.microstrategy.utils.serialization.Persistable
restoreState, restoreState, saveState, saveState, saveState, saveState
-
-
-
-
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 theLocale
instance to a Microsoft LCID then back again toLocale
- 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 fromEnumLocaleResolution
-
getResolution
int getResolution()
Resolution scheme to be used for resolvinggetLocale()
.- Returns:
- resolution scheme to be used for resolving
getLocale()
.
-
isFeatureAvailable
boolean isFeatureAvailable()
Only meaningful when invoked afterWebSessionInfo.getSessionID()
orWebIServerSession.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.
-
createCopy
WebLocale createCopy()
-
-