Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.everywhere
Class CommunityEverywhereManager

java.lang.Object
  extended by com.jivesoftware.forum.everywhere.CommunityEverywhereManager
All Implemented Interfaces:
ThreadListener

public class CommunityEverywhereManager
extends java.lang.Object
implements ThreadListener

Manages all aspects of the CommunityEverywhere feature.


Field Summary
static long INCLUDE_CSS
           
static long LIMIT_FIFTEEN_MESSAGES
           
static long LIMIT_FIVE_MESSAGES
           
static long LIMIT_TEN_MESSAGES
           
static long LIMIT_TWENTY_MESSAGES
           
static long NEW_WINDOW
           
static java.lang.String PROPERTY_ALLOWED_REFERERS
           
static java.lang.String PROPERTY_ENABLED
           
static java.lang.String PROPERTY_ROOT_USER
           
static long SHOW_LINK
           
static long SHOW_LINK_MESSAGES
           
static long SHOW_LINK_MESSAGES_COMMENT
           
static long SHOW_STATS
           
 
Method Summary
 void createThreadLink(java.lang.String key, long threadID)
           
 java.lang.String getAllowedReferers()
           
static CommunityEverywhereManager getInstance()
           
 User getRootUser()
           
 long getThreadLink(java.lang.String key)
           
 boolean isEnabled()
           
 void removeThreadLink(long threadID)
           
 void setAllowedReferers(java.lang.String allowedReferers)
           
 void setEnabled(boolean enabled)
           
 void setRootUser(User rootUser)
           
 void threadAdded(ThreadEvent event)
          Fired when a thread has been added to the system.
 void threadDeleted(ThreadEvent event)
          Fired when a thread is about to be deleted from the system.
 void threadModerationModified(ThreadEvent event)
          Fired when the moderation value of a thread has been changed.
 void threadMoved(ThreadEvent event)
          Fired when a thread is moved from one foru to another.
 void threadRated(ThreadEvent event)
          Fired when the thread has been rated.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_ENABLED

public static final java.lang.String PROPERTY_ENABLED
See Also:
Constant Field Values

PROPERTY_ALLOWED_REFERERS

public static final java.lang.String PROPERTY_ALLOWED_REFERERS
See Also:
Constant Field Values

PROPERTY_ROOT_USER

public static final java.lang.String PROPERTY_ROOT_USER
See Also:
Constant Field Values

SHOW_LINK

public static final long SHOW_LINK
See Also:
Constant Field Values

SHOW_LINK_MESSAGES

public static final long SHOW_LINK_MESSAGES
See Also:
Constant Field Values

SHOW_LINK_MESSAGES_COMMENT

public static final long SHOW_LINK_MESSAGES_COMMENT
See Also:
Constant Field Values

SHOW_STATS

public static final long SHOW_STATS
See Also:
Constant Field Values

LIMIT_FIVE_MESSAGES

public static final long LIMIT_FIVE_MESSAGES
See Also:
Constant Field Values

LIMIT_TEN_MESSAGES

public static final long LIMIT_TEN_MESSAGES
See Also:
Constant Field Values

LIMIT_FIFTEEN_MESSAGES

public static final long LIMIT_FIFTEEN_MESSAGES
See Also:
Constant Field Values

LIMIT_TWENTY_MESSAGES

public static final long LIMIT_TWENTY_MESSAGES
See Also:
Constant Field Values

NEW_WINDOW

public static final long NEW_WINDOW
See Also:
Constant Field Values

INCLUDE_CSS

public static final long INCLUDE_CSS
See Also:
Constant Field Values
Method Detail

getInstance

public static CommunityEverywhereManager getInstance()

getThreadLink

public long getThreadLink(java.lang.String key)

createThreadLink

public void createThreadLink(java.lang.String key,
                             long threadID)

removeThreadLink

public void removeThreadLink(long threadID)

threadAdded

public void threadAdded(ThreadEvent event)
Description copied from interface: ThreadListener
Fired when a thread has been added to the system.

Specified by:
threadAdded in interface ThreadListener
Parameters:
event - the event object.

threadDeleted

public void threadDeleted(ThreadEvent event)
Description copied from interface: ThreadListener
Fired when a thread is about to be deleted from the system. This event will only be fired when an individual thread is deleted; it is not fired when the forum that contains the thread is deleted. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the thread is deleted from the database.

Specified by:
threadDeleted in interface ThreadListener
Parameters:
event - the event object.

threadMoved

public void threadMoved(ThreadEvent event)
Description copied from interface: ThreadListener
Fired when a thread is moved from one foru to another.

Specified by:
threadMoved in interface ThreadListener
Parameters:
event - the event object.

threadModerationModified

public void threadModerationModified(ThreadEvent event)
Description copied from interface: ThreadListener
Fired when the moderation value of a thread has been changed.

Specified by:
threadModerationModified in interface ThreadListener
Parameters:
event - the event object.

threadRated

public void threadRated(ThreadEvent event)
Description copied from interface: ThreadListener
Fired when the thread has been rated.

Specified by:
threadRated in interface ThreadListener
Parameters:
event - the event object.

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getAllowedReferers

public java.lang.String getAllowedReferers()

setAllowedReferers

public void setAllowedReferers(java.lang.String allowedReferers)

getRootUser

public User getRootUser()

setRootUser

public void setRootUser(User rootUser)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.