Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.event
Class TagEvent

java.lang.Object
  extended by com.jivesoftware.forum.event.TagEvent
All Implemented Interfaces:
JiveEvent

public class TagEvent
extends java.lang.Object
implements JiveEvent

An event for Tag objects. 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 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 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 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.
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 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()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.