|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.event.ForumEvent
public class ForumEvent
An event for Forum objects. Certain event types will populate the params Map with additional objects as outlined below:
Event Type | Extra Params |
---|---|
FORUM_ADDED | None |
FORUM_DELETING | None |
FORUM_MODIFIED | None |
FORUM_MOVED | oldCategoryID (Long) -- category the forum was moved from. |
FORUM_MERGED | mergedForumID (Long) -- the ID of the forum that was
deleted in the merge. Note that the event will come from the forum that survives
the merge. mergedForumCategoryID (Long) -- the ID of the category of the forum that was deleted in the merge. |
Field Summary | |
---|---|
static int |
FORUM_ADDED
Forum was added. |
static int |
FORUM_DELETING
Forum is about to be deleted. |
static int |
FORUM_MERGED
Another forum was merged into the forum. |
static int |
FORUM_MODIFIED
Another forum was merged into the forum. |
static int |
FORUM_MOVED
The forum was moved to another category. |
Constructor Summary | |
---|---|
ForumEvent(int eventType,
Forum forum,
java.util.Map params)
Creates a new forum event. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
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. |
Forum |
getForum()
Returns the Forum that the event corresponds to. |
java.util.Map |
getParams()
Returns a map of parameters which can be used to pass data to a listener. |
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int FORUM_ADDED
public static final int FORUM_DELETING
public static final int FORUM_MOVED
public static final int FORUM_MERGED
public static final int FORUM_MODIFIED
Constructor Detail |
---|
public ForumEvent(int eventType, Forum forum, java.util.Map params)
eventType
- the type of the forum event.forum
- the forum the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public Forum getForum()
public java.util.Map getParams()
JiveEvent
getParams
in interface JiveEvent
public java.util.Date getDate()
JiveEvent
getDate
in interface JiveEvent
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |