public class

BulkEditOperation

extends Object
implements ProgressAwareBulkOperation
java.lang.Object
   ↳ com.atlassian.jira.bulkedit.operation.BulkEditOperation

Summary

Constants
String NAME
String NAME_KEY
Public Constructors
BulkEditOperation(IssueManager issueManager, PermissionManager permissionManager, ProjectManager projectManager, FieldManager fieldManager, JiraAuthenticationContext authenticationContext)
Public Methods
boolean canPerform(BulkEditBean bulkEditBean, ApplicationUser remoteUser)
Determines whether the operation can be performed with the given set of issues
boolean equals(Object o)
Map getActions(BulkEditBean bulkEditBean, ApplicationUser applicationUser)
Initialises all the bulk edit actions and returns them.
String getCannotPerformMessageKey()
An i18n key to be used to render the error message to be displayed when the user can not perform this bulk operation.
Map getCustomFieldActions(BulkEditBean bulkEditBean, ApplicationUser applicationUser)
String getDescriptionKey()
String getNameKey()
An i18n key used to display a short description of this operation in the UI.
int getNumberOfTasks(BulkEditBean bulkEditBean)
Returns number of tasks/stages to be executed as part of this bulk operation.
String getOperationName()
Returns the "operation name".
void perform(BulkEditBean bulkEditBean, ApplicationUser applicationUser, Context taskContext)
Performs the operation on the given set of issues and updates the progress.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.bulkedit.operation.ProgressAwareBulkOperation
From interface com.atlassian.jira.issue.operation.IssueOperation

Constants

public static final String NAME

Constant Value: "BulkEdit"

public static final String NAME_KEY

Constant Value: "bulk.edit.operation.name"

Public Constructors

public BulkEditOperation (IssueManager issueManager, PermissionManager permissionManager, ProjectManager projectManager, FieldManager fieldManager, JiraAuthenticationContext authenticationContext)

Public Methods

public boolean canPerform (BulkEditBean bulkEditBean, ApplicationUser remoteUser)

Determines whether the operation can be performed with the given set of issues

public boolean equals (Object o)

public Map getActions (BulkEditBean bulkEditBean, ApplicationUser applicationUser)

Initialises all the bulk edit actions and returns them.

Parameters
bulkEditBean bean used for actions retrieval
applicationUser remote user
Returns
  • bulk edit actions

public String getCannotPerformMessageKey ()

An i18n key to be used to render the error message to be displayed when the user can not perform this bulk operation.

Returns
  • An i18n key to be used to render the error message to be displayed when the user can not perform this bulk operation.

public Map getCustomFieldActions (BulkEditBean bulkEditBean, ApplicationUser applicationUser)

public String getDescriptionKey ()

public String getNameKey ()

An i18n key used to display a short description of this operation in the UI. e.g " Watch Issues "

Returns
  • An i18n key used to display a short description of this operation in the UI

public int getNumberOfTasks (BulkEditBean bulkEditBean)

Returns number of tasks/stages to be executed as part of this bulk operation. The number returned here must be consistent with the number of updates performed as part of perform(com.atlassian.jira.web.bean.BulkEditBean, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.task.context.Context).

Returns
  • Number of tasks/stages to be executed

public String getOperationName ()

Returns the "operation name".

This is used to build up the name of the action used to render the details screen in the bulk change UI.

The action name that is generated as operationName + "Details.jspa". See BulkChooseOperation for details

Returns
  • The "operation name"

public void perform (BulkEditBean bulkEditBean, ApplicationUser applicationUser, Context taskContext)

Performs the operation on the given set of issues and updates the progress.

During execution, the implementation class will update the progress by typically calling Context.start(object); on the context passed to get a task object, and subsequently call Context.Task.complete(); on the the task object to indicate task has finished.

Throws
BulkOperationException