com.jivesoftware.community.event
Class CommunityEvent

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

All Implemented Interfaces:

JiveEvent

public class CommunityEvent
extends java.lang.Object
implements JiveEvent

A class for Community events. This class will be passed to CommunityListeners whenever a community 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

COMMUNITY_ADDED

None

COMMUNITY_DELETING

None

COMMUNITY_MOVED

Name	Value
OriginalCommunity	The original community
DestinationCommunity	The destination community

COMMUNITY_MODIFIED

Reason	Name	Value
Name was modified	Type	nameModify
Name was modified	originalValue	The name before it was modified
Description was modified	Type	descriptionModify
Description was modified	originalValue	The description before it was modified
Property was modified	Type	propertyModify
Property was modified	PropertyKey	The name of the property
Property was modified	originalValue	The property value before it was modified
Property was added	Type	propertyAdd
Property was added	PropertyKey	The name of the new property
Property was deleted	Type	propertyDelete
Property was deleted	PropertyKey	The name of the property that is going to be deleted
A blog was added	Type	blogAdded
A blog was added	blog	The blog being added
A blog was removed	Type	blogRemoved
A blog was removed	blog	The blog being removed
Community index was changed	Type	IndexChange

COMMUNITY_MERGING

Name	Value
destCommunity	The destination community

Field Summary

static int	COMMUNITY_ADDED Event type for whenever a community is added to another community.
static int	COMMUNITY_DELETING Event type for whenever a community is about to be deleted.
static int	COMMUNITY_MERGING When two communities are merged
static int	COMMUNITY_MODIFIED Event type for whenever a community is modified.
static int	COMMUNITY_MOVED Event type for whenever a community is moved.

Constructor Summary

CommunityEvent(int eventType, Community community, java.util.Map<java.lang.String,?> params)

Method Summary

Community	getCommunity()
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,?>	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

COMMUNITY_ADDED

public static final int COMMUNITY_ADDED

Event type for whenever a community is added to another community.

See Also:

Constant Field Values

COMMUNITY_DELETING

public static final int COMMUNITY_DELETING

Event type for whenever a community is about to be deleted.

See Also:

Constant Field Values

COMMUNITY_MOVED

public static final int COMMUNITY_MOVED

Event type for whenever a community is moved.

See Also:

Constant Field Values

COMMUNITY_MODIFIED

public static final int COMMUNITY_MODIFIED

Event type for whenever a community is modified.

See Also:

Constant Field Values

COMMUNITY_MERGING

public static final int COMMUNITY_MERGING

When two communities are merged

See Also:

Constant Field Values

Constructor Detail

CommunityEvent

public CommunityEvent(int eventType,
                      Community community,
                      java.util.Map<java.lang.String,?> params)

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.

getCommunity

public Community getCommunity()

getParams

public java.util.Map<java.lang.String,?> 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.