com.atlassian.jira.bulkedit.operation

Class BulkEditOperation

java.lang.Object

com.atlassian.jira.bulkedit.operation.BulkEditOperation

All Implemented Interfaces:

ProgressAwareBulkOperation, IssueOperation

public class BulkEditOperation
extends Object
implements ProgressAwareBulkOperation

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME
static String	NAME_KEY

Constructor Summary

Constructors

Constructor and Description
BulkEditOperation(IssueManager issueManager, PermissionManager permissionManager, ProjectManager projectManager, FieldManager fieldManager, JiraAuthenticationContext authenticationContext)

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME_KEY

public static final String NAME_KEY

See Also:

Constant Field Values

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

BulkEditOperation

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

Method Detail

canPerform

public boolean canPerform(BulkEditBean bulkEditBean,
                          ApplicationUser remoteUser)

Description copied from interface: ProgressAwareBulkOperation

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

Specified by:

canPerform in interface ProgressAwareBulkOperation

See Also:

BulkEditBean.getSelectedIssues()

getActions

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

getCustomFieldActions

public Map getCustomFieldActions(BulkEditBean bulkEditBean,
                                 ApplicationUser applicationUser)

perform

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

Description copied from interface: ProgressAwareBulkOperation

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.

Specified by:

perform in interface ProgressAwareBulkOperation

Throws:

BulkOperationException

getNumberOfTasks

public int getNumberOfTasks(BulkEditBean bulkEditBean)

Description copied from interface: ProgressAwareBulkOperation

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 ProgressAwareBulkOperation.perform(com.atlassian.jira.web.bean.BulkEditBean, com.atlassian.jira.user.ApplicationUser, com.atlassian.jira.task.context.Context).

Specified by:

getNumberOfTasks in interface ProgressAwareBulkOperation

Returns:

Number of tasks/stages to be executed

getNameKey

public String getNameKey()

Description copied from interface: IssueOperation

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

Specified by:

getNameKey in interface IssueOperation

Returns:

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

getDescriptionKey

public String getDescriptionKey()

Specified by:

getDescriptionKey in interface IssueOperation

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getOperationName

public String getOperationName()

Description copied from interface: ProgressAwareBulkOperation

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

Specified by:

getOperationName in interface ProgressAwareBulkOperation

Returns:

The "operation name"

getCannotPerformMessageKey

public String getCannotPerformMessageKey()

Description copied from interface: ProgressAwareBulkOperation

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

Specified by:

getCannotPerformMessageKey in interface ProgressAwareBulkOperation

Returns:

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