|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.event.AnnouncementEvent
public class AnnouncementEvent
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 |
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 |
---|
public static final int ANNOUNCEMENT_CREATED
public static final int ANNOUNCEMENT_DELETED
public static final int ANNOUNCEMENT_MODIFIED
Constructor Detail |
---|
public AnnouncementEvent(int eventType, Announcement announcement, java.util.Map params)
eventType
- the type of the announcement event.announcement
- the announcement the event corresponds to.params
- parameters corresponding to the event.Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public Announcement getAnnouncment()
public java.util.Map getParams()
JiveEvent
getParams
in interface JiveEvent
public java.util.Date getDate()
JiveEvent
getDate
in interface JiveEvent
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |