com.jivesoftware.community.event
Class DocumentEvent

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

All Implemented Interfaces:

JiveEvent

public class DocumentEvent
extends java.lang.Object
implements JiveEvent

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

DOCUMENT_ADDED

None

DOCUMENT_DELETED

None

DOCUMENT_MOVED

Name	Value
OriginalCommunity	The original community
DestinationCommunity	The destination community

DOCUMENT_RELATED_DOCUMENT_ADDED

Name	Value
RelatedDocument	The related document added

DOCUMENT_RELATED_DOCUMENT_DELETED

Name	Value
RelatedDocument	The related document to be deleted

DOCUMENT_RATED

Name	Value
User	The user rating the document
Rating	A Rating object

DOCUMENT_MODIFIED

Reason	Name	Value
ExternalID was modified	Type	externalIDModify
ExternalID was modified	originalValue	The externalID before it was modified
Document type was modified	Type	documentTypeModify
Document type was modified	originalValue	The ID of the document type before it was modified as a String
Author was changed	Type	userModify
Author was changed	originalValue	The userID of the original author as a Long
Title was modified	Type	titleModify
Title was modified	originalValue	The title 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
Document index was changed	Type	IndexChange

Field Summary

static int	BINARY_BODY_DOWNLOADED Event type for when a binary body is downloaded
static int	DOCUMENT_ADDED Event type for whenever a document is added to a community.
static int	DOCUMENT_DELETING Event type for whenever a document is deleted from a community.
static int	DOCUMENT_EXPIRE_WARNING Event type for whenever a document is about to expire.
static int	DOCUMENT_EXPIRED Event type for whenever a document expires.
static int	DOCUMENT_MODIFIED Event type for whenever a document is modified.
static int	DOCUMENT_MOVED Event type for whenever a document is moved.
static int	DOCUMENT_RATED Event type for whenever a document is rated.
static int	DOCUMENT_RELATED_DOCUMENT_ADDED Event type for whenever a related document is added to a document.
static int	DOCUMENT_RELATED_DOCUMENT_DELETED Event type for whenever a related document is deleted from a document.
static int	DOCUMENT_UNDELETED Event type for whenever a document is un-deleted from a community.
static int	DOCUMENT_VIEWED Event type for when a document is marked as viewed
static int	VERSION_ADDED Event type for when a version is added
static int	VERSION_DELETING Event type for when a version is about to be deleted
static int	VERSION_MODIFIED Event type for when a version is modified

Constructor Summary

DocumentEvent(int eventType, Document document, Community community, java.util.Map<java.lang.String,? extends java.lang.Object> params)

Method Summary

Community	getCommunity()
java.util.Date	getCreated()
java.util.Date	getDate() Returns the date (as a Date object) that the event was created.
Document	getDocument()
int	getEventType() Returns the event type corresponding to the event.
JiveObject	getIdentifiedObject() Return an EntityDescriptor if document is null and documentID is not.
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.
boolean	isMinorRevision()
void	setCreated(java.util.Date created)
void	setMinorRevision(boolean minorRevision)

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_ADDED

public static final int DOCUMENT_ADDED

Event type for whenever a document is added to a community.

See Also:

Constant Field Values

DOCUMENT_DELETING

public static final int DOCUMENT_DELETING

Event type for whenever a document is deleted from a community.

See Also:

Constant Field Values

DOCUMENT_UNDELETED

public static final int DOCUMENT_UNDELETED

Event type for whenever a document is un-deleted from a community.

See Also:

Constant Field Values

DOCUMENT_MOVED

public static final int DOCUMENT_MOVED

Event type for whenever a document is moved.

See Also:

Constant Field Values

DOCUMENT_MODIFIED

public static final int DOCUMENT_MODIFIED

Event type for whenever a document is modified.

See Also:

Constant Field Values

DOCUMENT_EXPIRE_WARNING

public static final int DOCUMENT_EXPIRE_WARNING

Event type for whenever a document is about to expire.

See Also:

Constant Field Values

DOCUMENT_EXPIRED

public static final int DOCUMENT_EXPIRED

Event type for whenever a document expires.

See Also:

Constant Field Values

DOCUMENT_RELATED_DOCUMENT_ADDED

public static final int DOCUMENT_RELATED_DOCUMENT_ADDED

Event type for whenever a related document is added to a document.

See Also:

Constant Field Values

DOCUMENT_RELATED_DOCUMENT_DELETED

public static final int DOCUMENT_RELATED_DOCUMENT_DELETED

Event type for whenever a related document is deleted from a document.

See Also:

Constant Field Values

DOCUMENT_RATED

public static final int DOCUMENT_RATED

Event type for whenever a document is rated.

See Also:

Constant Field Values

DOCUMENT_VIEWED

public static final int DOCUMENT_VIEWED

Event type for when a document is marked as viewed

See Also:

Constant Field Values

VERSION_ADDED

public static final int VERSION_ADDED

Event type for when a version is added

See Also:

Constant Field Values

VERSION_MODIFIED

public static final int VERSION_MODIFIED

Event type for when a version is modified

See Also:

Constant Field Values

VERSION_DELETING

public static final int VERSION_DELETING

Event type for when a version is about to be deleted

See Also:

Constant Field Values

BINARY_BODY_DOWNLOADED

public static final int BINARY_BODY_DOWNLOADED

Event type for when a binary body is downloaded

See Also:

Constant Field Values

Constructor Detail

DocumentEvent

public DocumentEvent(int eventType,
                     Document document,
                     Community community,
                     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.

getDocument

public Document getDocument()

getCommunity

public Community getCommunity()

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.

getCreated

public java.util.Date getCreated()

setCreated

public void setCreated(java.util.Date created)

isMinorRevision

public boolean isMinorRevision()

setMinorRevision

public void setMinorRevision(boolean minorRevision)

getIdentifiedObject

public JiveObject getIdentifiedObject()

Return an EntityDescriptor if document is null and documentID is not.

Returns:

if document is null, an EntityDescriptor, otherwise the document itself.