DocumentRenamingEvent (XWiki Platform - Refactoring - API 15.4 API)

java.lang.Object
- org.xwiki.refactoring.internal.event.AbstractEvent
- - org.xwiki.refactoring.internal.event.AbstractEntityCopyOrRenameEvent<org.xwiki.model.reference.DocumentReference>
  - - org.xwiki.refactoring.event.DocumentRenamingEvent

All Implemented Interfaces:

Serializable, BeginEvent, BeginFoldEvent, CancelableEvent, Event
```
public class DocumentRenamingEvent
extends org.xwiki.refactoring.internal.event.AbstractEntityCopyOrRenameEvent<org.xwiki.model.reference.DocumentReference>
implements BeginFoldEvent, CancelableEvent
```
Event fired when a document is about to be renamed.
The event also send the following parameters:
- source: the job which produced this event or null for a remote event
- data: the MoveRequest request of the job which produced this event
Since:

11.1RC1

Version:

$Id: 959c06a8fdc50a1544b48406b50fe36d22c9ac15 $

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`DocumentRenamingEvent()`	Default constructor, used by listeners.
`DocumentRenamingEvent(org.xwiki.model.reference.DocumentReference sourceReference, org.xwiki.model.reference.DocumentReference targetReference)`	Creates a new instance with the given data.

Method Summary
- Methods inherited from class org.xwiki.refactoring.internal.event.AbstractEntityCopyOrRenameEvent
  equals, getSourceReference, getTargetReference, hashCode, matches
- Methods inherited from class org.xwiki.refactoring.internal.event.AbstractEvent
  cancel, cancel, getReason, isCanceled
- Methods inherited from class java.lang.Object
  clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
- Methods inherited from interface org.xwiki.observation.event.CancelableEvent
  cancel, cancel, getReason, isCanceled
- Methods inherited from interface org.xwiki.observation.event.Event
  matches

- Constructor Detail
  - DocumentRenamingEvent
```
public DocumentRenamingEvent()
```
    Default constructor, used by listeners.
  - DocumentRenamingEvent
```
public DocumentRenamingEvent(org.xwiki.model.reference.DocumentReference sourceReference,
                             org.xwiki.model.reference.DocumentReference targetReference)
```
    Creates a new instance with the given data.
    
    Parameters:
    
    sourceReference - the reference of the source entity
    
    targetReference - the reference of the target entity