com.atlassian.jira.plugin.projectoperation
Interface PluggableProjectOperation

All Known Implementing Classes:

AbstractPluggableProjectOperation, DefaultPluggableProjectOperation, ProjectOperation

@PublicSpi
public interface PluggableProjectOperation

A simple interface to create project operation plugins. These will be shown at the bottom of the project operation screen.

IMPORTANT NOTE: This plugin type is only available for internal use. Please refrain from using this, as the backwards compatibility of this plugin type will NOT be maintained in the future.

Since:

v3.12

Method Summary

String	getHtml(Project project, com.atlassian.crowd.embedded.api.User user) Get the HTML to present on screen
void	init(ProjectOperationModuleDescriptor descriptor)
boolean	showOperation(Project project, com.atlassian.crowd.embedded.api.User user) Whether or not to show this operation for the given project and user.

Method Detail

init

void init(ProjectOperationModuleDescriptor descriptor)

getHtml

String getHtml(Project project,
               com.atlassian.crowd.embedded.api.User user)

Get the HTML to present on screen

Parameters:

project - Provide the project in case we need any project specific information to render the HTML

user - The currently logged in user

Returns:

HTML representation for this project operation.

showOperation

boolean showOperation(Project project,
                      com.atlassian.crowd.embedded.api.User user)

Whether or not to show this operation for the given project and user.

Parameters:

project - Project being viewed

user - The currently logged in user

Returns:

true, if the link should be shown