DocumentRestoringEvent (XWiki Platform - Bridge 14.4 API)

java.lang.Object
- org.xwiki.observation.event.AbstractFilterableEvent
- - org.xwiki.observation.event.AbstractCancelableEvent
  - - org.xwiki.bridge.event.AbstractDocumentEvent
    - - org.xwiki.bridge.event.AbstractDocumentRestoreEvent
      - org.xwiki.bridge.event.DocumentRestoringEvent

All Implemented Interfaces:

Serializable, org.xwiki.observation.event.CancelableEvent, org.xwiki.observation.event.Event, org.xwiki.observation.event.FilterableEvent
```
public class DocumentRestoringEvent
extends AbstractDocumentRestoreEvent
```
An event triggered before a deleted document is restored.
The event also send the following parameters:
- source: what the document will look like after the restore
- data: the current {com.xpn.xwiki.XWikiContext} instance
Since:

13.7

Version:

$Id: 8836fb62f4a19dec2f98b54b3302affe50d8a38c $

See Also:

Serialized Form

Field Summary
- Fields inherited from class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
  deleteId

Constructor Summary

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

Method Summary
- Methods inherited from class org.xwiki.bridge.event.AbstractDocumentRestoreEvent
  getDeleteId, matches
- 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
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DocumentRestoringEvent
```
public DocumentRestoringEvent()
```
    Constructor initializing the event filter with an AlwaysMatchingEventFilter, meaning that this event will match any other document delete event.
  - DocumentRestoringEvent
```
public DocumentRestoringEvent(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
  - DocumentRestoringEvent
```
public DocumentRestoringEvent(org.xwiki.observation.event.filter.EventFilter eventFilter)
```
    Constructor using a custom EventFilter.
    
    Parameters:
    
    eventFilter - the filter to use for matching events
  - DocumentRestoringEvent
```
public DocumentRestoringEvent(DocumentReference documentReference,
                              long deleteId)
```
    Parameters:
    
    documentReference - the reference of the document to match
    
    deleteId - the unique identifier of the deleted document