@TransactionAware public class

PullRequestDeletionRequestedEvent

extends PullRequestEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.bitbucket.event.ApplicationEvent
       ↳ com.atlassian.bitbucket.event.pull.PullRequestEvent
         ↳ com.atlassian.bitbucket.event.pull.PullRequestDeletionRequestedEvent

Class Overview

Raised just before a pull request is deleted. This event is synchronous, allowing listeners to perform operations in the same database transaction where the pull request will be deleted.

This event is cancelable. A listener may prevent the pull request from being deleted by canceling this event. Throwing an exception will not prevent the pull request from being deleted; the exception will be logged and ignored.

See Also

Summary

[Expand]
Inherited Fields
From class java.util.EventObject
Public Constructors
PullRequestDeletionRequestedEvent(Object source, PullRequest pullRequest, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels pull request deletion, providing a message explaining why.
boolean isCanceled()
Retrieves a flag indicating whether pull request creation has already been canceled by another listener.
[Expand]
Inherited Methods
From class com.atlassian.bitbucket.event.pull.PullRequestEvent
From class com.atlassian.bitbucket.event.ApplicationEvent
From class java.util.EventObject
From class java.lang.Object
From interface com.atlassian.bitbucket.util.CancelState

Public Constructors

public PullRequestDeletionRequestedEvent (Object source, PullRequest pullRequest, CancelState cancelState)

Public Methods

public void cancel (KeyedMessage message)

Cancels pull request deletion, providing a message explaining why.

Parameters
message a descriptive message explaining why the operation has been canceled

public boolean isCanceled ()

Retrieves a flag indicating whether pull request creation has already been canceled by another listener.

Returns
  • true if another listener has already canceled pull request creation; otherwise, false