org.xwiki.bridge.event

Class DocumentDeletingEvent

java.lang.Object

org.xwiki.observation.event.AbstractFilterableEvent

org.xwiki.observation.event.AbstractCancelableEvent

org.xwiki.bridge.event.AbstractDocumentEvent

org.xwiki.bridge.event.DocumentDeletingEvent

All Implemented Interfaces:

Serializable, org.xwiki.observation.event.CancelableEvent, org.xwiki.observation.event.Event, org.xwiki.observation.event.FilterableEvent

public class DocumentDeletingEvent
extends AbstractDocumentEvent

An event triggered before a document is deleted.

The event also send the following parameters:

• source: what the document will look like after the delete, it's possible to access the deleted document using XWikDocument#getOriginalDocument()
• data: the current {com.xpn.xwiki.XWikiContext} instance

Since:

2.7RC1

Version:

$Id: 1a301985d9043449c8e7ad3200bc5e47473b2137 $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentDeletingEvent() Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
DocumentDeletingEvent(DocumentReference documentReference) Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.
DocumentDeletingEvent(org.xwiki.observation.event.filter.EventFilter eventFilter) Constructor using a custom EventFilter.

Method Summary

Methods inherited from class org.xwiki.observation.event.AbstractCancelableEvent

cancel, cancel, getReason, isCanceled

Methods inherited from class org.xwiki.observation.event.AbstractFilterableEvent

equals, getEventFilter, hashCode, matches

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xwiki.observation.event.Event

matches

Constructor Detail

DocumentDeletingEvent

public DocumentDeletingEvent()

Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.

DocumentDeletingEvent

public DocumentDeletingEvent(DocumentReference documentReference)

Constructor initializing the event filter with a FixedNameEventFilter, meaning that this event will match only delete events affecting the same document.

Parameters:

documentReference - the reference of the document to match

DocumentDeletingEvent

public DocumentDeletingEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)

Constructor using a custom EventFilter.

Parameters:

eventFilter - the filter to use for matching events