Interface BulkAction
-
- All Superinterfaces:
BulkActionScope
- All Known Subinterfaces:
RepositoryAwareBulkAction
- All Known Implementing Classes:
AbstractNotificationBulkAction
,AbstractRepositoryBulkAction
,AddNotificationBulkAction
,DeleteAllNotificationBulkAction
,DisablePlanBulkAction
,EnablePlanBulkAction
,ManualBuildBulkAction
,ReplaceTriggersBulkAction
,SvnBulkAction
,UpdateSvnCredentialsBulkAction
,UpdateSvnUrlBulkAction
,UpdateWebUrlBulkAction
public interface BulkAction extends BulkActionScope
Interface that defines an action that can be executed across multiple plans
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
BulkAction.WebWorkAction
static class
BulkAction.WebWorkActionImpl
-
Field Summary
Fields Modifier and Type Field Description static String
WW_NAMESPACE_ADMIN
static String
WW_NAMESPACE_BUILD_ADMIN
static String
WW_NAMESPACE_BUILD_ADMIN_EDIT
static String
WW_NAMESPACE_BULK_ACTIONS
static String
WW_NAMESPACE_CHAIN_ADMIN
static String
WW_NAMESPACE_CHAIN_CONFIG
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description @NotNull String
getChangedItem()
Description of what will be changed as a result of this bulk action, also used as table heading to show what will be changed and what it has changed to@NotNull BulkAction.WebWorkAction
getEditSnippetAction()
Action to return the edit snippet (no form tags) edit the value.@NotNull BulkAction.WebWorkAction
getExecuteAction()
The final action to execute to act on the bulk action@NotNull String
getKey()
Unique identifier for the action@NotNull BulkAction.WebWorkAction
getResultAction()
Action to view the new values after executing the bulk action@NotNull String
getTitle()
What the label for the bulk action is@NotNull BulkAction.WebWorkAction
getViewAction()
Action to run to get the view of the current value for this bulk action@NotNull BulkAction.WebWorkAction
getViewUpdatedAction()
Action to run to get the view of the updated value for this bulk actionboolean
hasUpdates()
Returns whether or not a plan's details have been updated in order to carry out the bulk actionvoid
populateActionParameters(@NotNull ActionParametersMap actionParameters, @NotNull ImmutablePlan plan)
Provides possibility to populate action parameters before executing bulk action.-
Methods inherited from interface com.atlassian.bamboo.ww2.actions.admin.bulk.BulkActionScope
isApplicable, isApplicableForRepositories
-
-
-
-
Field Detail
-
WW_NAMESPACE_ADMIN
static final String WW_NAMESPACE_ADMIN
- See Also:
- Constant Field Values
-
WW_NAMESPACE_BULK_ACTIONS
static final String WW_NAMESPACE_BULK_ACTIONS
- See Also:
- Constant Field Values
-
WW_NAMESPACE_BUILD_ADMIN
static final String WW_NAMESPACE_BUILD_ADMIN
- See Also:
- Constant Field Values
-
WW_NAMESPACE_BUILD_ADMIN_EDIT
static final String WW_NAMESPACE_BUILD_ADMIN_EDIT
- See Also:
- Constant Field Values
-
WW_NAMESPACE_CHAIN_CONFIG
static final String WW_NAMESPACE_CHAIN_CONFIG
- See Also:
- Constant Field Values
-
WW_NAMESPACE_CHAIN_ADMIN
static final String WW_NAMESPACE_CHAIN_ADMIN
- See Also:
- Constant Field Values
-
-
Method Detail
-
getKey
@NotNull @NotNull String getKey()
Unique identifier for the action- Returns:
-
getTitle
@NotNull @NotNull String getTitle()
What the label for the bulk action is- Returns:
-
getChangedItem
@NotNull @NotNull String getChangedItem()
Description of what will be changed as a result of this bulk action, also used as table heading to show what will be changed and what it has changed to- Returns:
-
getViewAction
@NotNull @NotNull BulkAction.WebWorkAction getViewAction()
Action to run to get the view of the current value for this bulk action- Returns:
-
getViewUpdatedAction
@NotNull @NotNull BulkAction.WebWorkAction getViewUpdatedAction()
Action to run to get the view of the updated value for this bulk action- Returns:
-
getEditSnippetAction
@NotNull @NotNull BulkAction.WebWorkAction getEditSnippetAction()
Action to return the edit snippet (no form tags) edit the value. The snippet will not have access to any plan values- Returns:
-
getExecuteAction
@NotNull @NotNull BulkAction.WebWorkAction getExecuteAction()
The final action to execute to act on the bulk action- Returns:
-
getResultAction
@NotNull @NotNull BulkAction.WebWorkAction getResultAction()
Action to view the new values after executing the bulk action- Returns:
-
hasUpdates
boolean hasUpdates()
Returns whether or not a plan's details have been updated in order to carry out the bulk action- Returns:
- true if updated
-
populateActionParameters
void populateActionParameters(@NotNull @NotNull ActionParametersMap actionParameters, @NotNull @NotNull ImmutablePlan plan)
Provides possibility to populate action parameters before executing bulk action.- Parameters:
actionParameters
- Action parameters to be populatedplan
- Plan which will be subject to action
-
-