Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum
Class ForumLocaleManager

java.lang.Object
  extended by com.jivesoftware.forum.ForumLocaleManager
All Implemented Interfaces:
LocaleManager

public class ForumLocaleManager
extends java.lang.Object
implements LocaleManager

A Forums instance of LocaleManager. Manages locale settings for forum objects.

See Also:
LocaleManager

Method Summary
static ForumLocaleManager getInstance()
           
 java.util.Locale getLocale(EntityDescriptor entityDescriptor, User user, javax.servlet.http.HttpServletRequest req)
          Returns a Locale object for the specified entity, if one exists.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static ForumLocaleManager getInstance()

getLocale

public java.util.Locale getLocale(EntityDescriptor entityDescriptor,
                                  User user,
                                  javax.servlet.http.HttpServletRequest req)
Description copied from interface: LocaleManager
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.

Specified by:
getLocale in interface LocaleManager
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.