com.jivesoftware.community.event
Class ProfileEvent

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

public class ProfileEvent
extends Object

A class for com.jivesoftware.community.user.profile.ProfileFieldValue 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 String	PARAM_FILTERABLE_FIELD_VALUE_MODIFIED
static String	PARAM_MODIFIED_FIELD_IDS
static int	PROFILE_MODIFIED Event type for whenever a user profile is modified.

Constructor Summary

ProfileEvent(int eventType, User user, Map<String,Object> params)

Method Summary

int	getEventType()
Exception	getFailureException() Returns the exception that indicates why a listener failed to handle an event.
Map<String,Object>	getParams()
User	getUser()
void	setFailureException(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

PARAM_MODIFIED_FIELD_IDS

public static final String PARAM_MODIFIED_FIELD_IDS

See Also:

Constant Field Values

PARAM_FILTERABLE_FIELD_VALUE_MODIFIED

public static final String PARAM_FILTERABLE_FIELD_VALUE_MODIFIED

See Also:

Constant Field Values

Constructor Detail

ProfileEvent

public ProfileEvent(int eventType,
                    User user,
                    Map<String,Object> params)

Method Detail

getEventType

public int getEventType()

getUser

public User getUser()

getParams

public Map<String,Object> getParams()

getFailureException

public 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(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.