Interface CancelableEvent

All Superinterfaces:
CancelState
All Known Subinterfaces:
PermissionGrantRequestedEvent, PermissionModificationRequestedEvent, PermissionRevocationRequestedEvent
All Known Implementing Classes:
AttachmentDeletionRequestedEvent, AttachmentSaveRequestedEvent, CommitDiscussionCancelableCommentEvent, CommitDiscussionCommentAddRequestedEvent, CommitDiscussionCommentDeletionRequestedEvent, CommitDiscussionCommentModificationRequestedEvent, CommitDiscussionCommentReplyRequestedEvent, GlobalPermissionGrantRequestedEvent, GlobalPermissionModificationRequestedEvent, GlobalPermissionRevocationRequestedEvent, ProjectCreationRequestedEvent, ProjectDeletionRequestedEvent, ProjectModificationRequestedEvent, ProjectPermissionGrantRequestedEvent, ProjectPermissionModificationRequestedEvent, ProjectPermissionRevocationRequestedEvent, PullRequestCancelableCommentEvent, PullRequestCommentAddRequestedEvent, PullRequestCommentDeletionRequestedEvent, PullRequestCommentModificationRequestedEvent, PullRequestCommentReplyRequestedEvent, PullRequestDeletionRequestedEvent, PullRequestOpenRequestedEvent, RepositoryCreationRequestedEvent, RepositoryDeletionRequestedEvent, RepositoryForkRequestedEvent, RepositoryModificationRequestedEvent, RepositoryPermissionGrantRequestedEvent, RepositoryPermissionModificationRequestedEvent, RepositoryPermissionRevocationRequestedEvent

public interface CancelableEvent extends CancelState
Augments an event with support for cancelation.

When a cancelable event is raised, any listener may choose to cancel the operation. A descriptive message must be provided, explaining why the operation was canceled. If any listener cancels the operation, it will not be performed--even if other listeners did not cancel. In other words, if three listeners receive the event and only one of them cancels, the associated operation will be considered canceled.