|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.event.UserEvent
public class UserEvent
A class for user events. This class will be passed to UserListeners whenever a user 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
USER_CREATED | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USER_DELETED | None | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
USER_MODIFIED |
|
Field Summary | |
---|---|
static int |
USER_CREATED
Event type for whenever a user is created. |
static int |
USER_DELETED
Event type for whenever a user is deleted. |
static int |
USER_MODIFIED
Event type for whenever a user is modified. |
Constructor Summary | |
---|---|
UserEvent(int eventType,
User user,
java.util.Map params)
|
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.lang.Exception |
getFailureException()
Returns the exception that indicates why a listener failed to handle an event. |
java.util.Map |
getParams()
Returns a map of parameters which can be used to pass data to a listener. |
User |
getUser()
|
void |
setFailureException(java.lang.Exception e)
Sets the exception that indicates why a listener failed to handle an event. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int USER_CREATED
public static final int USER_DELETED
public static final int USER_MODIFIED
Constructor Detail |
---|
public UserEvent(int eventType, User user, java.util.Map params)
Method Detail |
---|
public int getEventType()
JiveEvent
getEventType
in interface JiveEvent
public User getUser()
public java.util.Map getParams()
JiveEvent
getParams
in interface JiveEvent
public java.util.Date getDate()
JiveEvent
getDate
in interface JiveEvent
public java.lang.Exception getFailureException()
Sometimes the class triggering the event needs to know if any listeners for the event were unsuccessful for any reason. This is used internally by Jive classes and should be ignored by listener authors.
public void setFailureException(java.lang.Exception e)
Sometimes the class triggering the event needs to know if any listeners for the event were unsuccessful for any reason. Listeners can call this method to indicate that the event was not handled successfully in all cases. This is used internally by Jive classes ashould be ignored by listener authors.
e
- the exception.
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |