public class LanguageSetting
extends oracle.webcenter.generalsettings.internal.model.GSPreferences
LanguageSetting.getLocale()
, and set it in the
ADFContext
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
PREFERRED_LANGUAGE_KEY
The internal key that holds the preference value.
|
Constructor and Description |
---|
LanguageSetting() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
getDefaultLanguage()
Returns the default language preference for the application.
|
static java.util.Locale |
getLocale()
Returns the
Locale to use based on the preference set by the current
user. |
static java.util.Locale |
getLocale(java.lang.String username)
Returns the
Locale to use based on the preference set by the given
user. |
static java.lang.String |
getPreferredLanguage()
Returns the preferred language for the current user.
|
static java.lang.String |
getPreferredLanguage(boolean considerCookie)
Returns the preferred language for the current user.
|
static java.lang.String |
getPreferredLanguage(java.lang.String username)
Returns the preferred language for the given user.
|
static java.lang.String |
getPreferredLanguage(java.lang.String username,
boolean considerCookie)
Returns the preferred language for the given user.
|
static java.lang.String |
getPreferredUserDisplayNameLanguage()
Returns the user display name language for the current user.
|
static java.lang.String |
getPreferredUserDisplayNameLanguage(java.lang.String username)
Returns the user display name language for the given user.
|
static java.lang.String |
getUserDisplayNameLanguagePref()
Returns the user display name language preference for the current user.
|
static java.lang.String |
getUserDisplayNameLanguagePref(java.lang.String username)
Returns the user display name language preference for the given user.
|
static java.util.Locale |
getUserDisplayNameLocale()
Returns the
Locale to use for display names based on the
preference set by the current user. |
static java.util.Locale |
getUserDisplayNameLocale(java.lang.String username)
Returns the
Locale to use for display names based on the
preference set by the given user. |
static java.lang.String |
getUserLanguagePref()
Returns the language preference for the current user.
|
static java.lang.String |
getUserLanguagePref(java.lang.String username)
Returns the language preference for the given user.
|
static void |
setDefaultLanguage(java.lang.String defaultLanguage)
Sets the default language preference for the application.
|
static void |
setPreferredLanguage(java.lang.String preferredLanguage)
Deprecated.
replaced by setUserLanguagePref
|
static void |
setPreferredLanguage(java.lang.String username,
java.lang.String preferredLanguage)
Deprecated.
replaced by setUserLanguagePref
|
static void |
setUserDisplayNameLanguagePref(java.lang.String username,
java.lang.String userNameDisplayLanguage)
Sets the display name language preference for the given user.
|
static void |
setUserLanguagePref(java.lang.String preferredLanguage)
Sets the language preference for the current user.
|
static void |
setUserLanguagePref(java.lang.String username,
java.lang.String preferredLanguage)
Sets the language preference for the given user.
|
public static final java.lang.String PREFERRED_LANGUAGE_KEY
public static java.lang.String getPreferredLanguage()
public static java.lang.String getPreferredLanguage(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.lang.String getPreferredLanguage(boolean considerCookie)
considerCookie
- whether to consider the values from the cookiespublic static java.lang.String getPreferredLanguage(java.lang.String username, boolean considerCookie)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userconsiderCookie
- whether to consider the values from the cookiespublic static java.lang.String getPreferredUserDisplayNameLanguage(java.lang.String username)
username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.lang.String getPreferredUserDisplayNameLanguage()
public static java.lang.String getUserLanguagePref()
getPreferredLanguage()
API should be used.public static java.lang.String getUserLanguagePref(java.lang.String username)
getPreferredLanguage()
API should be used.username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.lang.String getUserDisplayNameLanguagePref(java.lang.String username)
getPreferredUserDisplayNameLanguage()
API should be used.username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userpublic static java.lang.String getUserDisplayNameLanguagePref()
getPreferredUserDisplayNameLanguage()
API should be used.public static void setPreferredLanguage(java.lang.String username, java.lang.String preferredLanguage)
public static void setPreferredLanguage(java.lang.String preferredLanguage)
public static void setUserLanguagePref(java.lang.String preferredLanguage)
preferredLanguage
- user's language preferencepublic static void setUserLanguagePref(java.lang.String username, java.lang.String preferredLanguage)
username
- the username to set the preference for. If null, sets
the preference for the current authenticated userpreferredLanguage
- user's language preferencepublic static void setUserDisplayNameLanguagePref(java.lang.String username, java.lang.String userNameDisplayLanguage)
username
- the username to set the preference for. If null, sets
the preference for the current authenticated useruserNameDisplayLanguage
- user's language preferencepublic static java.lang.String getDefaultLanguage()
public static void setDefaultLanguage(java.lang.String defaultLanguage)
defaultLanguage
- the application's default language preferencepublic static java.util.Locale getLocale()
Locale
to use based on the preference set by the current
user.
If the application is required to override the locale setting from each
user's browser, then this API must be used in a custom
ServletFilter
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.Locale
to use for all localizationpublic static java.util.Locale getLocale(java.lang.String username)
Locale
to use based on the preference set by the given
user.
If the application is required to override the locale setting from each
user's browser, then this API must be used in a custom
ServletFilter
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.username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userLocale
to use for all localizationpublic static java.util.Locale getUserDisplayNameLocale()
Locale
to use for display names based on the
preference set by the current user.Locale
to use for display namespublic static java.util.Locale getUserDisplayNameLocale(java.lang.String username)
Locale
to use for display names based on the
preference set by the given user.username
- the username to obtain the preference for. If null, obtains
the preference for the current authenticated userLocale
to use for display names