com.jivesoftware.community.event
Class AttachmentEvent

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

All Implemented Interfaces:

JiveEvent

public class AttachmentEvent
extends java.lang.Object
implements JiveEvent

A class for Attachment events. This class will be passed to AttachmentListeners whenever an attachment event is fired and contains all the pertinent information to the event.

Field Summary

static int	ATTACHMENT_ADDED Event type for whenever an attachment is added to a document.
static int	ATTACHMENT_DELETING Event type for whenever an attachment is about to be deleted.
static int	ATTACHMENT_DOWNLOADED Event type for whenever an attachment was download
static int	ATTACHMENT_MODIFIED Event type for whenever an attachment was modified

Constructor Summary

AttachmentEvent(int eventType, JiveObject jiveObject, Attachment attachment, java.util.Map<java.lang.String,? extends java.lang.Object> params)

Method Summary

Attachment	getAttachment()
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.
JiveObject	getJiveObject()
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ATTACHMENT_ADDED

public static final int ATTACHMENT_ADDED

Event type for whenever an attachment is added to a document.

See Also:

Constant Field Values

ATTACHMENT_DELETING

public static final int ATTACHMENT_DELETING

Event type for whenever an attachment is about to be deleted.

See Also:

Constant Field Values

ATTACHMENT_DOWNLOADED

public static final int ATTACHMENT_DOWNLOADED

Event type for whenever an attachment was download

See Also:

Constant Field Values

ATTACHMENT_MODIFIED

public static final int ATTACHMENT_MODIFIED

Event type for whenever an attachment was modified

See Also:

Constant Field Values

Constructor Detail

AttachmentEvent

public AttachmentEvent(int eventType,
                       JiveObject jiveObject,
                       Attachment attachment,
                       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.

getJiveObject

public JiveObject getJiveObject()

getAttachment

public Attachment getAttachment()

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.