com.jivesoftware.base.event
Class GroupEvent

java.lang.Object
  com.jivesoftware.base.event.GroupEvent

All Implemented Interfaces:

JiveEvent

public class GroupEvent
extends java.lang.Object
implements JiveEvent

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

GROUP_CREATED

None

GROUP_DELETED

None

GROUP_USER_ADDED

A param named 'User' with a 'User' object as a payload

GROUP_USER_DELETED

A param named 'User' with a 'User' object as a payload

GROUP_ADMINISTRATOR_ADDED

A param named 'Administrator' with a 'User' object as a payload

GROUP_ADMINISTRATOR_DELETED

A param named 'Administrator' with a 'User' object as a payload

GROUP_MODIFIED

Reason	Name	Value
Name was modified	Type	nameModify
Name was modified	originalValue	The name before it was modified
Description was modified	Type	descriptionModify
Description was modified	originalValue	The description before it was modified
Property was modified	Type	propertyModify
Property was modified	PropertyKey	The name of the property
Property was modified	originalValue	The property value before it was modified
Property was added	Type	propertyAdd
Property was added	PropertyKey	The name of the new property
Property was deleted	Type	propertyDelete
Property was deleted	PropertyKey	The name of the property that is going to be deleted

Field Summary

static int	GROUP_ADMINISTRATOR_ADDED Event type for whenever an administrator is added to a group.
static int	GROUP_ADMINISTRATOR_DELETED Event type for whenever an administrator is deleted from a group.
static int	GROUP_CREATED Event type for whenever a group is created.
static int	GROUP_DELETED Event type for whenever a group is deleted.
static int	GROUP_MODIFIED Event type for whenever a group is modified (properties added, etc).
static int	GROUP_USER_ADDED Event type for whenever a user is added to a group.
static int	GROUP_USER_DELETED Event type for whenever a user is deleted from a group.

Constructor Summary

GroupEvent(int eventType, Group group, java.util.Map<java.lang.String,? extends java.lang.Object> 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.
Group	getGroup()
java.util.Map<java.lang.String,? extends java.lang.Object>	getParams() Returns a map of parameters which can be used to pass data to a listener.
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

GROUP_CREATED

public static final int GROUP_CREATED

Event type for whenever a group is created.

See Also:

Constant Field Values

GROUP_DELETED

public static final int GROUP_DELETED

Event type for whenever a group is deleted.

See Also:

Constant Field Values

GROUP_USER_ADDED

public static final int GROUP_USER_ADDED

Event type for whenever a user is added to a group.

See Also:

Constant Field Values

GROUP_USER_DELETED

public static final int GROUP_USER_DELETED

Event type for whenever a user is deleted from a group.

See Also:

Constant Field Values

GROUP_ADMINISTRATOR_ADDED

public static final int GROUP_ADMINISTRATOR_ADDED

Event type for whenever an administrator is added to a group.

See Also:

Constant Field Values

GROUP_ADMINISTRATOR_DELETED

public static final int GROUP_ADMINISTRATOR_DELETED

Event type for whenever an administrator is deleted from a group.

See Also:

Constant Field Values

GROUP_MODIFIED

public static final int GROUP_MODIFIED

Event type for whenever a group is modified (properties added, etc).

See Also:

Constant Field Values

Constructor Detail

GroupEvent

public GroupEvent(int eventType,
                  Group group,
                  java.util.Map<java.lang.String,? extends java.lang.Object> params)

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.

getGroup

public Group getGroup()

getParams

public java.util.Map<java.lang.String,? extends java.lang.Object> 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.

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.