com.jivesoftware.community.event
Class TagEvent

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

All Implemented Interfaces:

JiveEvent

public class TagEvent
extends java.lang.Object
implements JiveEvent

A class for ContentTag events. This class will be passed to TagListeners whenever a tag 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_CREATED	None

Field Summary

static int	TAG_ADDED A tag was added to an object.
static int	TAG_CREATED Tag was added to the system.
static int	TAG_REMOVED A tag was removed from an object.

Constructor Summary

TagEvent(int eventType, ContentTag tag, java.util.Map<java.lang.String,? extends java.lang.Object> params, long parentObjectID, int parentObjectType)
Creates a new tag 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.
long	getParentObjectID()
int	getParentObjectType()
ContentTag	getTag() Returns the tag 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_CREATED

public static final int TAG_CREATED

Tag was added to the system.

See Also:

Constant Field Values

TAG_ADDED

public static final int TAG_ADDED

A tag was added to an object.

See Also:

Constant Field Values

TAG_REMOVED

public static final int TAG_REMOVED

A tag was removed from an object.

See Also:

Constant Field Values

Constructor Detail

TagEvent

public TagEvent(int eventType,
                ContentTag tag,
                java.util.Map<java.lang.String,? extends java.lang.Object> params,
                long parentObjectID,
                int parentObjectType)

Creates a new tag event.

Parameters:

eventType - the type of the tag event.

tag - the tag the event corresponds to.

params - parameters corresponding to the event.

parentObjectID - the parent object id

parentObjectType - the parent object type

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.

getTag

public ContentTag getTag()

Returns the tag that the event corresponds to.

Returns:

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

getParentObjectID

public long getParentObjectID()

getParentObjectType

public int getParentObjectType()