com.jivesoftware.forum.event
Class AnnouncementEvent

java.lang.Object
  com.jivesoftware.forum.event.AnnouncementEvent

All Implemented Interfaces:

JiveEvent

public class AnnouncementEvent
extends java.lang.Object
implements JiveEvent

An event for Announcement objects. Certain event types will populate the params Map with additional objects as outlined below:

Event Type	Extra Params
ANNOUNCEMENT_CREATED	None
ANNOUNCEMENT_DELETED	None
ANNOUNCEMENT_MODIFIED	None

Since:

4.0

Field Summary

static int	ANNOUNCEMENT_CREATED Announcement was added to the system.
static int	ANNOUNCEMENT_DELETED Announcement was deleted.
static int	ANNOUNCEMENT_MODIFIED The announcement was modified.

Constructor Summary

AnnouncementEvent(int eventType, Announcement announcement, java.util.Map params)
Creates a new announcement event.

Method Summary

Announcement	getAnnouncment() Returns the Announcement that the event corresponds to.
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.

Methods inherited from class java.lang.Object

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

Field Detail

ANNOUNCEMENT_CREATED

public static final int ANNOUNCEMENT_CREATED

Announcement was added to the system.

See Also:

Constant Field Values

ANNOUNCEMENT_DELETED

public static final int ANNOUNCEMENT_DELETED

Announcement was deleted.

See Also:

Constant Field Values

ANNOUNCEMENT_MODIFIED

public static final int ANNOUNCEMENT_MODIFIED

The announcement was modified. This will happen when the subject, body, or extended properties are changed.

See Also:

Constant Field Values

Constructor Detail

AnnouncementEvent

public AnnouncementEvent(int eventType,
                         Announcement announcement,
                         java.util.Map params)

Creates a new announcement event.

Parameters:

eventType - the type of the announcement event.

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

getAnnouncment

public Announcement getAnnouncment()

Returns the Announcement that the event corresponds to.

Returns:

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