com.jivesoftware.community.event
Class ThreadEvent

java.lang.Object
  com.jivesoftware.community.event.ThreadEvent

All Implemented Interfaces:

JiveEvent

public class ThreadEvent
extends java.lang.Object
implements JiveEvent

A class for ForumThread events. This class will be passed to ThreadListeners whenever a thread event is fired and contains all the pertinent information to the event.

Certain event types will populate the params Map with additional objects as outlined below:

Event Type	Extra Params
THREAD_ADDED	None
THREAD_DELETING	None
THREAD_MOVED	oldCommunityID (Long) -- the ID of the community the thread used to belong to.
THREAD_MODERATION_MODIFIED	oldModerationValue (Integer) -- the old moderation value of the thread. moderatorID (Long) -- the userID of user that made the moderation change, or -1 if userID is unknown or not present.
THREAD_VIEWED	None

Field Summary

static int	THREAD_ADDED Thread was added to the system.
static int	THREAD_DELETING Thread is about to be deleted.
static int	THREAD_MODERATION_MODIFIED The moderation value of the thread was changed.
static int	THREAD_MOVED Thread was moved to another community.
static int	THREAD_RATED The thread was rated.
static int	THREAD_VIEWED The thread was viewed.

Constructor Summary

ThreadEvent(int eventType, ForumThread thread, java.util.Map<java.lang.String,? extends java.lang.Object> params)
Creates a new thread event.

Method Summary

java.util.Date	getDate() Returns the date (as a Date object) that the event was created.
int	getEventType() Returns the event type corresponding to the event.
JiveObject	getIdentifiedObject() Return an EntityDescriptor if thread is null and threadID is not.
java.util.Map<java.lang.String,? extends java.lang.Object>	getParams() Returns a map of parameters which can be used to pass data to a listener.
ForumThread	getThread() Returns the ForumThread that the event corresponds to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

THREAD_ADDED

public static final int THREAD_ADDED

Thread was added to the system.

See Also:

Constant Field Values

THREAD_DELETING

public static final int THREAD_DELETING

Thread is about to be deleted.

See Also:

Constant Field Values

THREAD_MOVED

public static final int THREAD_MOVED

Thread was moved to another community.

See Also:

Constant Field Values

THREAD_MODERATION_MODIFIED

public static final int THREAD_MODERATION_MODIFIED

The moderation value of the thread was changed.

See Also:

Constant Field Values

THREAD_RATED

public static final int THREAD_RATED

The thread was rated.

See Also:

Constant Field Values

THREAD_VIEWED

public static final int THREAD_VIEWED

The thread was viewed.

See Also:

Constant Field Values

Constructor Detail

ThreadEvent

public ThreadEvent(int eventType,
                   ForumThread thread,
                   java.util.Map<java.lang.String,? extends java.lang.Object> params)

Creates a new thread event.

Parameters:

eventType - the type of the message event.

thread - the message the event corresponds to.

params - parameters corresponding to the event.

Method Detail

getEventType

public int getEventType()

Description copied from interface: JiveEvent

Returns the event type corresponding to the event.

Specified by:

getEventType in interface JiveEvent

Returns:

the event type corresponding to the event.

getThread

public ForumThread getThread()

Returns the ForumThread that the event corresponds to.

Returns:

the thread the event corresponds to.

getParams

public java.util.Map<java.lang.String,? extends java.lang.Object> getParams()

Description copied from interface: JiveEvent

Returns a map of parameters which can be used to pass data to a listener.

Specified by:

getParams in interface JiveEvent

Returns:

map of parameters which can be used to pass data to a listener.

getDate

public java.util.Date getDate()

Description copied from interface: JiveEvent

Returns the date (as a Date object) that the event was created.

Specified by:

getDate in interface JiveEvent

Returns:

the date (as a Date object) that the event was created.

getIdentifiedObject

public JiveObject getIdentifiedObject()

Return an EntityDescriptor if thread is null and threadID is not.

Returns:

if thread is null, an EntityDescriptor, otherwise the thread itself.