com.jivesoftware.community.event
Class BlogEvent

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

All Implemented Interfaces:

JiveEvent

public class BlogEvent
extends java.lang.Object
implements JiveEvent

A class for Blog events. This class will be passed to BlogListeners whenever a blog 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
BLOG_CREATED	None
BLOG_DELETING	None
BLOG_MODIFIED	None

Field Summary

static int	BLOG_CREATED Blog was added to the system.
static int	BLOG_DELETING Blog is about to be deleted.
static int	BLOG_MODIFIED Blog was modified.

Constructor Summary

BlogEvent(int eventType, Blog blog, java.util.Map<java.lang.String,? extends java.lang.Object> params)
Creates a new blog event.

Method Summary

Blog	getBlog() Returns the blog 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<java.lang.String,? extends java.lang.Object>	getParams() Returns a map of parameters which can be used to pass data to a listener.

Methods inherited from class java.lang.Object

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

Field Detail

BLOG_CREATED

public static final int BLOG_CREATED

Blog was added to the system.

See Also:

Constant Field Values

BLOG_DELETING

public static final int BLOG_DELETING

Blog is about to be deleted.

See Also:

Constant Field Values

BLOG_MODIFIED

public static final int BLOG_MODIFIED

Blog was modified.

See Also:

Constant Field Values

Constructor Detail

BlogEvent

public BlogEvent(int eventType,
                 Blog blog,
                 java.util.Map<java.lang.String,? extends java.lang.Object> params)

Creates a new blog event.

Parameters:

eventType - the type of the blog event.

blog - the blog 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.

getBlog

public Blog getBlog()

Returns the blog that the event corresponds to.

Returns:

the blog 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.