org.xwiki.bridge.event

Class DocumentVersionRangeDeletedEvent

java.lang.Object

org.xwiki.observation.event.AbstractFilterableEvent

org.xwiki.observation.event.AbstractCancelableEvent

org.xwiki.bridge.event.AbstractDocumentEvent

org.xwiki.bridge.event.DocumentVersionRangeDeletedEvent

All Implemented Interfaces:

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

public class DocumentVersionRangeDeletedEvent
extends AbstractDocumentEvent
implements org.xwiki.observation.event.EndEvent

An event triggered after one or several versions of a document history have been deleted.

The event also send the following parameters:

• source: the current {com.xpn.xwiki.doc.XWikiDocument} instance
• data: the current {com.xpn.xwiki.XWikiContext} instance

Since:

13.5RC1

Version:

$Id: 1f0d4f60f7478bdae90db81421dd6f9f016091fa $

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentVersionRangeDeletedEvent() Matches all DocumentVersionRangeDeletedEvent events.
DocumentVersionRangeDeletedEvent(DocumentReference documentReference, String from, String to)
DocumentVersionRangeDeletedEvent(org.xwiki.observation.event.filter.EventFilter eventFilter) Constructor using a custom EventFilter to match the document reference.

Method Summary

Modifier and Type	Method and Description
String	getFrom()
String	getTo()

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

DocumentVersionRangeDeletedEvent

public DocumentVersionRangeDeletedEvent()

Matches all DocumentVersionRangeDeletedEvent events.

DocumentVersionRangeDeletedEvent

public DocumentVersionRangeDeletedEvent(DocumentReference documentReference,
                                        String from,
                                        String to)

Parameters:

documentReference - the reference of the document to match

from - the oldest version deleted

to - the most recent version deleted

DocumentVersionRangeDeletedEvent

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

Constructor using a custom EventFilter to match the document reference.

Parameters:

eventFilter - the filter to use for matching events

Method Detail

getFrom

public String getFrom()

Returns:

the from

getTo

public String getTo()

Returns:

the to