com.jivesoftware.community.event
Class TagSetEvent

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

All Implemented Interfaces:

JiveEvent

public class TagSetEvent
extends java.lang.Object
implements JiveEvent

A class for TagSet events. This class will be passed to TagSetListeners whenever a tag set 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
TAG_SET_CREATED	None
TAG_SET_MODIFIED	None
TAG_SET_REMOVED	None

Field Summary

static int	TAG_SET_CREATED Tag set was added to the system.
static int	TAG_SET_DELETED Tag set was removed from the system
static int	TAG_SET_MODIFIED Tag set was modified

Constructor Summary

TagSetEvent(int eventType, TagSet tagSet, java.util.Map<java.lang.String,? extends java.lang.Object> params)
Creates a new tag set event.

Method Summary

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.
TagSet	getTagSet() Returns the tag set that the event corresponds to.

Methods inherited from class java.lang.Object

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

Field Detail

TAG_SET_CREATED

public static final int TAG_SET_CREATED

Tag set was added to the system.

See Also:

Constant Field Values

TAG_SET_MODIFIED

public static final int TAG_SET_MODIFIED

Tag set was modified

See Also:

Constant Field Values

TAG_SET_DELETED

public static final int TAG_SET_DELETED

Tag set was removed from the system

See Also:

Constant Field Values

Constructor Detail

TagSetEvent

public TagSetEvent(int eventType,
                   TagSet tagSet,
                   java.util.Map<java.lang.String,? extends java.lang.Object> params)

Creates a new tag set event.

Parameters:

eventType - the type of the tag event.

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

getTagSet

public TagSet getTagSet()

Returns the tag set that the event corresponds to.

Returns:

the tag set 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.