com.jivesoftware.community
Interface LocaleManager

All Superinterfaces:

JiveManager

public interface LocaleManager
extends JiveManager

Manages Locale settings for various objects.

Method Summary

Locale	getGlobaleLocale() Returns the global Locale used by Jive.
Locale	getLocale(Community community, User user, HttpServletRequest req) Returns a Locale object for the specified entity, if one exists.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy

Method Detail

getGlobaleLocale

Locale getGlobaleLocale()

Returns the global Locale used by Jive. A locale specifies language and country codes, and is used for internationalization. The default locale is system dependant and is determined by calling Locale.getDefault().

Returns:

the global locale used by Jive.

getLocale

Locale getLocale(Community community,
                 User user,
                 HttpServletRequest req)

Returns a Locale object for the specified entity, if one exists. If a locale does not exist for the specific entity, it's parent entries will be checked. If a locale could not be found in the entity tree, the user specific locale will be returned, if it exists, otherwise the default Jive locale will be returned.

Parameters:

community - the community of the current action

user - the user associated with the request

req - the servlet request object, used to load the users locale.

Returns:

the locale associated with the entityDescriptor, or the user, or the default Jive locale.

See Also:

EntityDescriptor, User