Summary: Methods | [Expand All]
@PublicSpi public interface

PreDeleteUserErrors

com.atlassian.jira.plugin.user.PreDeleteUserErrors
Known Indirect Subclasses

@PublicSpi

This interface is designed for plugins to implement.

Clients of @PublicSpi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicSpi as per each product's API policy (clients should refer to each product's API policy for the exact guarantee -- usually binary compatibility is guaranteed at least across minor versions).

Note: @PublicSpi interfaces and classes are specifically designed to be implemented/extended by clients. Hence, the guarantee of binary compatibility is different to that of @PublicApi elements (if an element is both @PublicApi and @PublicSpi, both guarantees apply).

Class Overview

Interface defines the implementation point for plugins wishing to interact with the pre-delete-user-errors plugin point. Implementing this interface and returning a non-empty collection of WebErrorMessage indicates the provided user should not be deleted.

Summary

Public Methods
List<WebErrorMessage> getPreDeleteUserErrors(ApplicationUser user)
This will be called when a user is about to be deleted.

Public Methods

public List<WebErrorMessage> getPreDeleteUserErrors (ApplicationUser user)

This will be called when a user is about to be deleted. Returning a non-empty list of WebErrorMessage will prevent the user from being deleted.

Parameters
user that is being considered for deletion
Returns