com.jivesoftware.community.event
Class TrackbackEvent

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

All Implemented Interfaces:

JiveEvent

public class TrackbackEvent
extends java.lang.Object
implements 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_MODIFIED	None

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, java.util.Map<java.lang.String,? extends java.lang.Object> params)
Creates a new trackback 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.
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,
                      java.util.Map<java.lang.String,? extends java.lang.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()

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.

getTrackback

public Trackback getTrackback()

Returns the trackback that the event corresponds to.

Returns:

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