com.jivesoftware.community.event
Class CommunityEvent

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

public class CommunityEvent
extends 

A class for Community events. This class will be passed to EventListeners 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

ADDED

None

DELETING

None

DELETED

None

MOVED

Name	Value
OriginalCommunity	The original community
DestinationCommunity	The destination 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

MERGING

Name	Value
destCommunity	The destination community

Nested Class Summary

static class

CommunityEvent.Type

Field Summary

static String	KEY_DEST_COMMUNITY
static String	KEY_DEST_COMMUNITY_PARENT
static String	PARAM_VIEW_TYPE

Constructor Summary

CommunityEvent()

CommunityEvent(CommunityEvent.Type eventType, Community community)

CommunityEvent(CommunityEvent.Type eventType, Community community, Map<String,Object> params)

Method Summary

ContainerEvent.ModificationType	getContainerModificationType() A modification type from the list below that corresponds to the implementing event's type.
EntityDescriptor	getDestination()
EntityDescriptor	getDestinationParent()
EntityDescriptor	getParent()

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_VIEW_TYPE

public static final String PARAM_VIEW_TYPE

See Also:

Constant Field Values

KEY_DEST_COMMUNITY

public static final String KEY_DEST_COMMUNITY

See Also:

Constant Field Values

KEY_DEST_COMMUNITY_PARENT

public static final String KEY_DEST_COMMUNITY_PARENT

See Also:

Constant Field Values

Constructor Detail

CommunityEvent

public CommunityEvent()

CommunityEvent

public CommunityEvent(CommunityEvent.Type eventType,
                      Community community)

CommunityEvent

public CommunityEvent(CommunityEvent.Type eventType,
                      Community community,
                      Map<String,Object> params)

Method Detail

getContainerModificationType

public ContainerEvent.ModificationType getContainerModificationType()

A modification type from the list below that corresponds to the implementing event's type.

Returns:

a ModificationType.

getParent

public EntityDescriptor getParent()

getDestination

public EntityDescriptor getDestination()

getDestinationParent

public EntityDescriptor getDestinationParent()