com.jivesoftware.community.event
Class TagEvent

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

public class TagEvent
extends 

A class for ContentTag events. This class will be passed to listeners 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
CREATED	None
ADDED	None
REMOVED	None

Nested Class Summary

static class

TagEvent.Type

Constructor Summary

TagEvent()

TagEvent(TagEvent.Type eventType, ContentTag tag, Map<String,Object> params, JiveObject parent)
Creates a new tag event.

TagEvent(TagEvent.Type eventType, ContentTag tag, Map<String,Object> params, JiveObject parent, EntityDescriptor owner)
Creates a new tag event.

Method Summary

long	getIndirectObjectID() Get the id of the Indirect object, or -1 if the given event's Type is not ditransitive.
int	getIndirectObjectType() Get the type of the Indirect object, or -1 if the given event's Type is not ditransitive.
EntityDescriptor	getOwner()
EntityDescriptor	getParent()

Methods inherited from class java.lang.Object

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

Constructor Detail

TagEvent

public TagEvent()

TagEvent

public TagEvent(TagEvent.Type eventType,
                ContentTag tag,
                Map<String,Object> params,
                JiveObject parent)

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.

parent - the parent object

TagEvent

public TagEvent(TagEvent.Type eventType,
                ContentTag tag,
                Map<String,Object> params,
                JiveObject parent,
                EntityDescriptor owner)

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.

parent - the parent object

owner - the owner of the given tag, only relevant for Community Tags.

Method Detail

getParent

public EntityDescriptor getParent()

getIndirectObjectID

public long getIndirectObjectID()

Get the id of the Indirect object, or -1 if the given event's Type is not ditransitive.

Returns:

an long ID, or -1 if the given event's Type is not ditransitive.

getIndirectObjectType

public int getIndirectObjectType()

Get the type of the Indirect object, or -1 if the given event's Type is not ditransitive.

Returns:

an integer type, or -1 if the given event's Type is not ditransitive.

getOwner

public EntityDescriptor getOwner()