Clearspace API (2.5.29) Core Javadocs

com.jivesoftware.community.event
Class TrackbackEvent

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

public class TrackbackEvent
extends Object
implements com.jivesoftware.community.JiveEvent

A class for Trackback events. This class will be passed to TrackbackListeners whenever a trackback 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
TRACKBACK_CREATED None
TRACKBACK_DELETED None
TRACKBACK_MODIFIEDNone


Field Summary
static int TRACKBACK_CREATED
          Trackback was added to the system.
static int TRACKBACK_DELETED
          Trackback was deleted.
static int TRACKBACK_MODIFIED
          Trackback was modified.
 
Constructor Summary
TrackbackEvent(int eventType, Trackback trackback, Map<String,? extends Object> params)
          Creates a new trackback event.
 
Method Summary
 Date getDate()
           
 int getEventType()
           
 Map<String,? extends Object> getParams()
           
 Trackback getTrackback()
          Returns the trackback 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

TRACKBACK_CREATED

public static final int TRACKBACK_CREATED
Trackback was added to the system.

See Also:
Constant Field Values

TRACKBACK_DELETED

public static final int TRACKBACK_DELETED
Trackback was deleted.

See Also:
Constant Field Values

TRACKBACK_MODIFIED

public static final int TRACKBACK_MODIFIED
Trackback was modified.

See Also:
Constant Field Values
Constructor Detail

TrackbackEvent

public TrackbackEvent(int eventType,
                      Trackback trackback,
                      Map<String,? extends Object> params)
Creates a new trackback event.

Parameters:
eventType - the type of the trackback event.
trackback - the trackback 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

getTrackback

public Trackback getTrackback()
Returns the trackback that the event corresponds to.

Returns:
the trackback 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.