@PublicSpi public interface ProgressAwareBulkOperation extends IssueOperation
BulkOperation
which didn't report the operation progress.
Bulk operations are added by plugins via BulkOperationManager.addBulkOperation(java.lang.String, java.lang.Class<? extends com.atlassian.jira.bulkedit.operation.BulkOperation>)
.
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
|
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.
|
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 remoteUser,
Context taskContext)
Performs the operation on the given set of issues and updates the progress.
|
getDescriptionKey, getNameKey
String getOperationName()
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
String getCannotPerformMessageKey()
boolean canPerform(BulkEditBean bulkEditBean, ApplicationUser remoteUser)
BulkEditBean.getSelectedIssues()
void perform(BulkEditBean bulkEditBean, ApplicationUser remoteUser, Context taskContext) throws BulkOperationException
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.
BulkOperationException
int getNumberOfTasks(BulkEditBean bulkEditBean)
perform(com.atlassian.jira.web.bean.BulkEditBean, com.atlassian.jira.user.ApplicationUser,
com.atlassian.jira.task.context.Context)
.Copyright © 2002-2017 Atlassian. All Rights Reserved.