Clearspace API (2.5.22) Core Javadocs

com.jivesoftware.community.event
Class TagSetEvent

java.lang.Object
  extended by com.jivesoftware.community.event.TagSetEvent
All Implemented Interfaces:
com.jivesoftware.community.JiveEvent

public class TagSetEvent
extends Object
implements com.jivesoftware.community.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, Map<String,? extends Object> params)
          Creates a new tag set event.
 
Method Summary
 Date getDate()
           
 int getEventType()
           
 Map<String,? extends Object> getParams()
           
 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,
                   Map<String,? extends 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()
Specified by:
getEventType in interface com.jivesoftware.community.JiveEvent

getTagSet

public TagSet getTagSet()
Returns the tag set that the event corresponds to.

Returns:
the tag set the event corresponds to.

getParams

public Map<String,? extends Object> getParams()
Specified by:
getParams in interface com.jivesoftware.community.JiveEvent

getDate

public Date getDate()
Specified by:
getDate in interface com.jivesoftware.community.JiveEvent

Clearspace Project Page

Copyright © 1999-2007 Jive Software.