|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.8.0) E15995-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.generalsettings.internal.model.GSPreferences
oracle.webcenter.generalsettings.model.LanguageSetting
public class LanguageSetting
The LanguageSetting class provides shared preferences for language settings. Gets and sets the locale preference for a user. This class must be used when an application is required 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, this class must be used along with a ServletFilter to get the preferred locale, through LanguageSetting.getLocale()
, and set it in the ADFContext
.
Field Summary | |
---|---|
static java.lang.String |
PREFERRED_LANGUAGE_KEY The internal key that holds 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() 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. |
Methods inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences |
---|
getPreferred, getPreferred, getProvider, getSystemPref, getUserPref, getUserPref, log, setSystemPref, setUserPref |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PREFERRED_LANGUAGE_KEY
Constructor Detail |
---|
public LanguageSetting()
Method Detail |
---|
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
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.8.0) E15995-07 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |