Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.base
Interface LocaleManager

All Known Implementing Classes:
ForumLocaleManager

public interface LocaleManager

Manages Locale settings for various objects.


Method Summary
 java.util.Locale getLocale(EntityDescriptor entityDescriptor, User user, javax.servlet.http.HttpServletRequest req)
          Returns a Locale object for the specified entity, if one exists.
 

Method Detail

getLocale

java.util.Locale getLocale(EntityDescriptor entityDescriptor,
                           User user,
                           javax.servlet.http.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:
entityDescriptor - the object describing a specific entity
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

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.