Clearspace API (2.5.18) Core Javadocs

com.jivesoftware.community.event
Class BlogEvent

java.lang.Object
  extended by com.jivesoftware.community.event.BlogEvent
All Implemented Interfaces:
com.jivesoftware.community.JiveEvent

public class BlogEvent
extends Object
implements com.jivesoftware.community.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_MODIFIEDNone


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.
static int BLOG_MOVED
          Blog was moved
 
Constructor Summary
BlogEvent(int eventType, Blog blog, Map<String,? extends Object> params)
          Creates a new blog event.
 
Method Summary
 Blog getBlog()
          Returns the blog that the event corresponds to.
 Date getDate()
           
 int getEventType()
           
 Map<String,? extends Object> getParams()
           
 
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

BLOG_MOVED

public static final int BLOG_MOVED
Blog was moved

See Also:
Constant Field Values
Constructor Detail

BlogEvent

public BlogEvent(int eventType,
                 Blog blog,
                 Map<String,? extends 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()
Specified by:
getEventType in interface com.jivesoftware.community.JiveEvent

getBlog

public Blog getBlog()
Returns the blog that the event corresponds to.

Returns:
the blog the event corresponds to.

getParams

public Map<String,? extends Object> getParams()
Specified by:
getParams in interface com.jivesoftware.community.JiveEvent

getDate

public Date getDate()
Specified by:
getDate in interface com.jivesoftware.community.JiveEvent

Clearspace Project Page

Copyright © 1999-2007 Jive Software.