Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.database
Class WatchListener

java.lang.Object
  extended by com.jivesoftware.forum.database.WatchListener
All Implemented Interfaces:
UserListener, CategoryListener, ForumListener, MessageListener, ThreadListener

public class WatchListener
extends java.lang.Object
implements CategoryListener, ForumListener, ThreadListener, MessageListener, UserListener

Listens for events generated by forum activity and triggers watch updates as appropriate.


Constructor Summary
WatchListener(DbWatchManager manager, WatchSettingsManager settings)
           
 
Method Summary
 void categoryAdded(CategoryEvent event)
          Fired when a category has been added to the system.
 void categoryDeleted(CategoryEvent event)
          Fired when a category is about to be deleted from the system.
 void categoryModified(CategoryEvent event)
          Fired when a category has been modified.
 void categoryMoved(CategoryEvent event)
          Fired when a category has been moved from one category to another.
 void forumAdded(ForumEvent event)
          Fired when a forum has been added to the system.
 void forumDeleted(ForumEvent event)
          Fired when a forum is about to be deleted from the system.
 void forumMerged(ForumEvent event)
          Fired when a forum is merged into another forum.
 void forumModified(ForumEvent event)
          Fired when a forum is modified.
 void forumMoved(ForumEvent event)
          Fired when a forum has been moved from one category to another.
 void messageAdded(MessageEvent event)
          Fired when a message has been added to the system.
 void messageDeleted(MessageEvent event)
          Fired when a message is about to be deleted from the system.
 void messageModerationModified(MessageEvent event)
          Fired when the moderation value of a message has been changed.
 void messageModified(MessageEvent event)
          Fired when portions of a message have been modified.
 void messageMoved(MessageEvent event)
          Fired when a message is moved to another thread.
 void messageRated(MessageEvent event)
          Fired when a message has been rated.
 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.
 void userCreated(UserEvent event)
          Fired when a user is created.
 void userDeleted(UserEvent event)
          Fired when a user is deleted.
 void userModified(UserEvent event)
          Fired when a user is modified.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WatchListener

public WatchListener(DbWatchManager manager,
                     WatchSettingsManager settings)
Method Detail

categoryAdded

public void categoryAdded(CategoryEvent event)
Description copied from interface: CategoryListener
Fired when a category has been added to the system.

Specified by:
categoryAdded in interface CategoryListener
Parameters:
event - the event object.

categoryDeleted

public void categoryDeleted(CategoryEvent event)
Description copied from interface: CategoryListener
Fired when a category is about to be deleted from the system. Because various code pieces may depend on this event for performing cleanup tasks, it's guaranteed that this method will be called before the category is deleted from the database.

Specified by:
categoryDeleted in interface CategoryListener
Parameters:
event - the event object.

categoryModified

public void categoryModified(CategoryEvent event)
Description copied from interface: CategoryListener
Fired when a category has been modified.

Specified by:
categoryModified in interface CategoryListener
Parameters:
event - the event object.

categoryMoved

public void categoryMoved(CategoryEvent event)
Description copied from interface: CategoryListener
Fired when a category has been moved from one category to another.

Specified by:
categoryMoved in interface CategoryListener
Parameters:
event - the event object.

forumAdded

public void forumAdded(ForumEvent event)
Description copied from interface: ForumListener
Fired when a forum has been added to the system.

Specified by:
forumAdded in interface ForumListener
Parameters:
event - the event object.

forumDeleted

public void forumDeleted(ForumEvent event)
Description copied from interface: ForumListener
Fired when a forum is about to be deleted from the system. This event will be fired when an individual forum is deleted or when the forum's category 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 forum is deleted from the database.

Specified by:
forumDeleted in interface ForumListener
Parameters:
event - the event object.

forumModified

public void forumModified(ForumEvent event)
Description copied from interface: ForumListener
Fired when a forum is modified.

Specified by:
forumModified in interface ForumListener
Parameters:
event - the event object.

forumMoved

public void forumMoved(ForumEvent event)
Description copied from interface: ForumListener
Fired when a forum has been moved from one category to another.

Specified by:
forumMoved in interface ForumListener
Parameters:
event - the event object.

forumMerged

public void forumMerged(ForumEvent event)
Description copied from interface: ForumListener
Fired when a forum is merged into another forum.

Specified by:
forumMerged in interface ForumListener
Parameters:
event - the event object.

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.

messageAdded

public void messageAdded(MessageEvent event)
Description copied from interface: MessageListener
Fired when a message has been added to the system. Care should be taken with this event type since a message being added may need to go through a moderation process before it becomes visible in a forum. Therefore, actions that should only be triggered after moderation has taken place should use the message moderation modified event type instead.

Specified by:
messageAdded in interface MessageListener
Parameters:
event - the event object.

messageDeleted

public void messageDeleted(MessageEvent event)
Description copied from interface: MessageListener
Fired when a message is about to be deleted from the system. This event will only be fired when an individual message is deleted; it is not fired when the thread or forum that contains the message 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 message is deleted from the database.

Specified by:
messageDeleted in interface MessageListener
Parameters:
event - the event object.

messageModified

public void messageModified(MessageEvent event)
Description copied from interface: MessageListener
Fired when portions of a message have been modified.

Specified by:
messageModified in interface MessageListener
Parameters:
event - the event object.

messageMoved

public void messageMoved(MessageEvent event)
Description copied from interface: MessageListener
Fired when a message is moved to another thread. This happens when a thread is branched such that a message and its children become a new thread.

Specified by:
messageMoved in interface MessageListener
Parameters:
event - the event object.

messageModerationModified

public void messageModerationModified(MessageEvent event)
Description copied from interface: MessageListener
Fired when the moderation value of a message has been changed.

Specified by:
messageModerationModified in interface MessageListener
Parameters:
event - the event object.

messageRated

public void messageRated(MessageEvent event)
Description copied from interface: MessageListener
Fired when a message has been rated.

Specified by:
messageRated in interface MessageListener
Parameters:
event - the event object.

userCreated

public void userCreated(UserEvent event)
Description copied from interface: UserListener
Fired when a user is created.

Specified by:
userCreated in interface UserListener
Parameters:
event - the UserEvent

userDeleted

public void userDeleted(UserEvent event)
Description copied from interface: UserListener
Fired when a user is deleted.

Specified by:
userDeleted in interface UserListener
Parameters:
event - the UserEvent

userModified

public void userModified(UserEvent event)
Description copied from interface: UserListener
Fired when a user is modified.

Specified by:
userModified in interface UserListener
Parameters:
event - the UserEvent

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.