Jive Forums API (5.5.20.2-oracle) Core Javadocs

com.jivesoftware.forum.event
Class CategoryEvent

java.lang.Object
  extended by com.jivesoftware.forum.event.CategoryEvent
All Implemented Interfaces:
JiveEvent

public class CategoryEvent
extends java.lang.Object
implements JiveEvent

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

CATEGORY_ADDED

public static final int CATEGORY_ADDED
Category was added.

See Also:
Constant Field Values

CATEGORY_DELETING

public static final int CATEGORY_DELETING
Category is about to be deleted. Note: the getCategory() method will return null for this type of event.

See Also:
Constant Field Values

CATEGORY_MOVED

public static final int CATEGORY_MOVED
The category was moved to another category.

See Also:
Constant Field Values

CATEGORY_MODIFIED

public static final int CATEGORY_MODIFIED
The category was moved to another category.

See Also:
Constant Field Values
Constructor Detail

CategoryEvent

public CategoryEvent(int eventType,
                     ForumCategory category,
                     java.util.Map params)
Creates a new forum event.

Parameters:
eventType - the type of the category event.
category - the category 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.

getCategory

public ForumCategory getCategory()
Returns the ForumCategory that the event corresponds to.

Returns:
the category the event corresponds to.

getParams

public java.util.Map 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.

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.