Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.profiles
Class ProfileEvent

java.lang.Object
  extended by com.jivesoftware.profiles.ProfileEvent

public class ProfileEvent
extends java.lang.Object

A class for profile events. This class will be passed to ProfileListeners whenever a profile 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:


Field Summary
static int PROFILE_MODIFIED
          Event type for whenever a user profile is modified.
static int SKILLS_MODIFIED
          Event type for whenever user skills are modified.
 
Constructor Summary
ProfileEvent(int eventType, User user)
           
 
Method Summary
 int getEventType()
           
 java.lang.Exception getFailureException()
          Returns the exception that indicates why a listener failed to handle an event.
 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

PROFILE_MODIFIED

public static final int PROFILE_MODIFIED
Event type for whenever a user profile is modified.

See Also:
Constant Field Values

SKILLS_MODIFIED

public static final int SKILLS_MODIFIED
Event type for whenever user skills are modified.

See Also:
Constant Field Values
Constructor Detail

ProfileEvent

public ProfileEvent(int eventType,
                    User user)
Method Detail

getEventType

public int getEventType()

getUser

public User getUser()

getFailureException

public java.lang.Exception getFailureException()
Returns the exception that indicates why a listener failed to handle an event. This will return null if no exception occurred.

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.

Returns:
the failure exception.

setFailureException

public void setFailureException(java.lang.Exception e)
Sets the exception that indicates why a listener failed to handle an event.

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.

Parameters:
e - the exception.

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.