Skip navigation links

oracle.webcenter.generalsettings.model
Class LanguageSetting

java.lang.Object
oracle.webcenter.generalsettings.internal.model.GSPreferences
oracle.webcenter.generalsettings.model.LanguageSetting

public class LanguageSetting

extends oracle.webcenter.generalsettings.internal.model.GSPreferences

Shared Preferences for 'Language' Settings. This class can be used to get and set the preferred user Locale and should only be used if the application wishes to override the locale setting from each user's browser. By default, the locale is selected based on the HTTP request object and specified by the user in their browser settings. To allow users to specify their preferred locale in the application, then this class should be used along with a ServletFilter to get the preferred locale, via LanguageSetting.getLocale(), and set it in the ADFContext.

Field Summary

static java.lang.String

PREFERRED_LANGUAGE_KEY The internal key used to hold the preference value.

Fields inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

NULL_VALUE

Constructor Summary

LanguageSetting()

Method Summary

static java.lang.String	getDefaultLanguage() Return the default language preference for the application, null if system preference does not exist.
static java.util.Locale	getLocale() Return the Locale to use as preferred by the current user.
static java.lang.String	getPreferredLanguage() Return the preferred language for the current user, null if user and default preferences do not exist.
static java.lang.String	getUserLanguagePref() Return the language preference for the current user, null if user preference does not exist.
static void	setDefaultLanguage(java.lang.String defaultLanguage) Set the default language preference for the application.
static void	setPreferredLanguage(java.lang.String preferredLanguage) Deprecated. replaced by setUserLanguagePref
static void	setUserLanguagePref(java.lang.String preferredLanguage) Set the language preference for the current user.

Methods inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

getPreferred, getProvider, getSystemPref, getUserPref, setSystemPref, setUserPref

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PREFERRED_LANGUAGE_KEY

public static final java.lang.String PREFERRED_LANGUAGE_KEY

The internal key used to hold the preference value.

See Also:

Constant Field Values

Constructor Detail

LanguageSetting

public LanguageSetting()

Method Detail

getPreferredLanguage

public static java.lang.String getPreferredLanguage()

Return the preferred language for the current user, null if user and default preferences do not exist.

Returns:

user's preferred language, null if user and default preferences do not exist

getUserLanguagePref

public static java.lang.String getUserLanguagePref()

Return the language preference for the current user, null if user preference does not exist.

Returns:

user's language preference, null if user preference does not exist

setPreferredLanguage

public static void setPreferredLanguage(java.lang.String preferredLanguage)

Deprecated. replaced by setUserLanguagePref

setUserLanguagePref

public static void setUserLanguagePref(java.lang.String preferredLanguage)

Set the language preference for the current user.

Parameters:

preferredLanguage - user's language preference

getDefaultLanguage

public static java.lang.String getDefaultLanguage()

Return the default language preference for the application, null if system preference does not exist.

Returns:

the application's default language preference setting, null if system preference does not exist.

setDefaultLanguage

public static void setDefaultLanguage(java.lang.String defaultLanguage)

Set the default language preference for the application.

Parameters:

defaultLanguage - The application default language preference

getLocale

public static java.util.Locale getLocale()

Return the Locale to use as preferred by the current user. If the application wishes to override the locale setting from each user's browser, then this API will need to be used in a custom ServletFilter in order to set the Locale value in ADFContext which is used by Faces and all WebCenter services. Without this the Locale specified by the user's browser will be used.

Returns:

Locale to use for all localization

Skip navigation links