public class

ProjectModificationRequestedEvent

extends AbstractProjectModificationEvent
implements CancelableEvent
java.lang.Object
   ↳ java.util.EventObject
     ↳ com.atlassian.stash.event.StashEvent
       ↳ com.atlassian.stash.event.ProjectEvent
         ↳ com.atlassian.stash.event.AbstractProjectModificationEvent
           ↳ com.atlassian.stash.event.ProjectModificationRequestedEvent

Class Overview

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

When this event is raised, the project's persisted state has not been updated, so getProject() matches the old values.

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

This event is internally audited with a LOW priority.

Summary

[Expand]
Inherited Fields
From class com.atlassian.stash.event.AbstractProjectModificationEvent
From class java.util.EventObject
Public Constructors
ProjectModificationRequestedEvent(Object source, Project oldValue, Project newValue, CancelState cancelState)
Public Methods
void cancel(KeyedMessage message)
Cancels project modification, providing a message explaining why.
boolean isCanceled()
Retrieves a flag indicating whether project modification has already been canceled by another listener.
[Expand]
Inherited Methods
From class com.atlassian.stash.event.AbstractProjectModificationEvent
From class com.atlassian.stash.event.ProjectEvent
From class com.atlassian.stash.event.StashEvent
From class java.util.EventObject
From class java.lang.Object
From interface com.atlassian.stash.util.CancelState

Public Constructors

public ProjectModificationRequestedEvent (Object source, Project oldValue, Project newValue, CancelState cancelState)

Public Methods

public void cancel (KeyedMessage message)

Cancels project modification, 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 project modification has already been canceled by another listener.

Returns
  • true if another listener has already canceled project modification; otherwise, false