com.atlassian.jira.bulkedit.operation
Interface BulkOperation

All Superinterfaces:

IssueOperation

All Known Subinterfaces:

BulkMoveOperation

All Known Implementing Classes:

AbstractBulkOperation, BulkDeleteOperation, BulkEditOperation, BulkMigrateOperation, BulkMoveOperationImpl, BulkTransitionIssueOperation, BulkUnwatchOperation, BulkWatchOperation, BulkWorkflowTransitionOperation

@PublicSpi
public interface BulkOperation
extends IssueOperation

This interface is implemented by plugin vendors to define new bulk operations.

Method Summary

boolean	canPerform(BulkEditBean bulkEditBean, com.atlassian.crowd.embedded.api.User 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.
String	getOperationName() Returns the "operation name".
void	perform(BulkEditBean bulkEditBean, com.atlassian.crowd.embedded.api.User remoteUser) Performs the operation on the given set of issues

Methods inherited from interface com.atlassian.jira.issue.operation.IssueOperation

getDescriptionKey, getNameKey

Method Detail

canPerform

boolean canPerform(BulkEditBean bulkEditBean,
                   com.atlassian.crowd.embedded.api.User remoteUser)

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

See Also:

BulkEditBean.getSelectedIssues()

perform

void perform(BulkEditBean bulkEditBean,
             com.atlassian.crowd.embedded.api.User remoteUser)
             throws Exception

Performs the operation on the given set of issues

Throws:

Exception

getOperationName

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"

getCannotPerformMessageKey

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.