com.jivesoftware.community.event
Interface DocumentListener

public interface DocumentListener

A DocumentListener gets notified anytime a document event is fired. Concrete implementations of this class must have a zero argument constructor.

Method Summary

void	binaryBodyDownloaded(DocumentEvent event) Fied when a document's binary body is downloaded
void	documentAdded(DocumentEvent event) Fired when a document is added.
void	documentDeleted(DocumentEvent event) Fired when a document is deleted.
void	documentExpired(DocumentEvent event) Fired when a document expires.
void	documentExpireWarning(DocumentEvent event) Fired when a document is about to expire.
void	documentModified(DocumentEvent event) Fired when a document is modified.
void	documentMoved(DocumentEvent event) Fired when a document is moved.
void	documentRated(DocumentEvent event) Fired when a document is rated.
void	documentRelatedObjectAdded(DocumentEvent event) Fired when a related document is added to a document.
void	documentRelatedObjectDeleted(DocumentEvent event) Fired when a related document is deleted from a document.
void	documentUndeleted(DocumentEvent event) Fired when a document is un-deleted in the admin console.
void	documentViewed(DocumentEvent event) Fired when a document is marked as read.
void	versionAdded(DocumentEvent event) Fied when a new version is added to a document.
void	versionDeleting(DocumentEvent event) Fied when a version is about to be deleted from a document.
void	versionModified(DocumentEvent event) Fied when a version is modified.

Method Detail

documentAdded

void documentAdded(DocumentEvent event)

Fired when a document is added.

Parameters:

event - the DocumentEvent

documentDeleted

void documentDeleted(DocumentEvent event)

Fired when a document is deleted. Note: This is usually a rare case. In most cases, when a document is deleted, the state of the document is simply changed to deleted. This means that you will need to use the document modified method, and check the document state for deleted.

Parameters:

event - the DocumentEvent

documentMoved

void documentMoved(DocumentEvent event)

Fired when a document is moved.

Parameters:

event - the DocumentEvent

documentModified

void documentModified(DocumentEvent event)

Fired when a document is modified.

Parameters:

event - the DocumentEvent

documentUndeleted

void documentUndeleted(DocumentEvent event)

Fired when a document is un-deleted in the admin console. Actually the document is modified.

Parameters:

event - the DocumentEvent

documentExpireWarning

void documentExpireWarning(DocumentEvent event)

Fired when a document is about to expire.

Parameters:

event - the DocumentEvent

documentExpired

void documentExpired(DocumentEvent event)

Fired when a document expires.

Parameters:

event - the DocumentEvent

documentRelatedObjectAdded

void documentRelatedObjectAdded(DocumentEvent event)

Fired when a related document is added to a document.

Parameters:

event - the DocumentEvent

documentRelatedObjectDeleted

void documentRelatedObjectDeleted(DocumentEvent event)

Fired when a related document is deleted from a document.

Parameters:

event - the DocumentEvent

documentRated

void documentRated(DocumentEvent event)

Fired when a document is rated.

Parameters:

event - the DocumentEvent

documentViewed

void documentViewed(DocumentEvent event)

Fired when a document is marked as read.

Parameters:

event - the DocumentEvent

versionAdded

void versionAdded(DocumentEvent event)

Fied when a new version is added to a document.

Parameters:

event - the DocumentEvent

versionModified

void versionModified(DocumentEvent event)

Fied when a version is modified.

Parameters:

event - the DocumentEvent

versionDeleting

void versionDeleting(DocumentEvent event)

Fied when a version is about to be deleted from a document.

Parameters:

event - the DocumentEvent

binaryBodyDownloaded

void binaryBodyDownloaded(DocumentEvent event)

Fied when a document's binary body is downloaded

Parameters:

event - the DocumentEvent