|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.event.CategoryEvent
public class CategoryEvent
An event for ForumCategory objects. Certain event types will populate the params Map with additional objects as outlined below:
Event Type | Extra Params |
---|---|
CATEGORY_ADDED | None |
CATEGORY_DELETING | None |
CATEGORY_MOVED |
Field Summary | |
---|---|
static int |
CATEGORY_ADDED
Category was added. |
static int |
CATEGORY_DELETING
Category is about to be deleted. |
static int |
CATEGORY_MODIFIED
The category was moved to another category. |
static int |
CATEGORY_MOVED
The category was moved to another category. |
Constructor Summary | |
---|---|
CategoryEvent(int eventType,
ForumCategory category,
java.util.Map params)
Creates a new forum event. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
ForumCategory |
getCategory()
Returns the ForumCategory that the event corresponds to. |
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. |
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 CATEGORY_ADDED
public static final int CATEGORY_DELETING
getCategory()
method will return null for
this type of event.
public static final int CATEGORY_MOVED
public static final int CATEGORY_MODIFIED
Constructor Detail |
---|
public CategoryEvent(int eventType, ForumCategory category, java.util.Map params)
eventType
- the type of the category event.category
- the category the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public ForumCategory getCategory()
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 |