com.atlassian.bamboo.ww2.actions.admin.bulk
Interface BulkAction

All Known Implementing Classes:

AbstractNotificationBulkAction, AddNotificationBulkAction, DeleteAllNotificationBulkAction, ManualBuildBulkAction, UpdateCvsModuleBulkAction, UpdateCvsRootCredentialsBulkAction, UpdateSvnCredentialsBulkAction, UpdateSvnUrlBulkAction, UpdateWebUrlBulkAction

public interface BulkAction

Interface that defines an action that can be executed across multiple plans

Nested Class Summary

static interface	BulkAction.WebWorkAction
static class	BulkAction.WebWorkActionImpl

Field Summary

static java.lang.String	WW_NAMESPACE_ADMIN
static java.lang.String	WW_NAMESPACE_BUILD_ADMIN
static java.lang.String	WW_NAMESPACE_BUILD_ADMIN_EDIT
static java.lang.String	WW_NAMESPACE_CHAIN_ADMIN

Method Summary

java.lang.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
BulkAction.WebWorkAction	getEditSnippetAction() Action to return the edit snippet (no form tags) edit the value.
BulkAction.WebWorkAction	getExecuteAction() The final action to execute to act on the bulk action
java.lang.String	getKey() Unique identifier for the action
BulkAction.WebWorkAction	getResultAction() Action to view the new values after executing the bulk action
java.lang.String	getTitle() What the label for the bulk action is
BulkAction.WebWorkAction	getViewAction() Action to run to get the view of the current value for this bulk action
BulkAction.WebWorkAction	getViewUpdatedAction() Action to run to get the view of the updated value for this bulk action
boolean	hasUpdates() Returns whether or not a plan's details have been updated in order to carry out the bulk action
boolean	isApplicable(Plan plan) Returns whether or not a plan is applicable for a certain bulk action, eg.
boolean	isApplicableForJobs() Returns whether an action is applicable for subplans
void	populateActionParameters(ActionParametersMap actionParameters, Plan plan) Provides possibility to populate action parameters before executing bulk action.

Field Detail

WW_NAMESPACE_ADMIN

static final java.lang.String WW_NAMESPACE_ADMIN

See Also:

Constant Field Values

WW_NAMESPACE_BUILD_ADMIN

static final java.lang.String WW_NAMESPACE_BUILD_ADMIN

See Also:

Constant Field Values

WW_NAMESPACE_BUILD_ADMIN_EDIT

static final java.lang.String WW_NAMESPACE_BUILD_ADMIN_EDIT

See Also:

Constant Field Values

WW_NAMESPACE_CHAIN_ADMIN

static final java.lang.String WW_NAMESPACE_CHAIN_ADMIN

See Also:

Constant Field Values

Method Detail

getKey

@NotNull
java.lang.String getKey()

Unique identifier for the action

Returns:

getTitle

@NotNull
java.lang.String getTitle()

What the label for the bulk action is

Returns:

getChangedItem

@NotNull
java.lang.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
BulkAction.WebWorkAction getViewAction()

Action to run to get the view of the current value for this bulk action

Returns:

getViewUpdatedAction

@NotNull
BulkAction.WebWorkAction getViewUpdatedAction()

Action to run to get the view of the updated value for this bulk action

Returns:

getEditSnippetAction

@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
BulkAction.WebWorkAction getExecuteAction()

The final action to execute to act on the bulk action

Returns:

getResultAction

@NotNull
BulkAction.WebWorkAction getResultAction()

Action to view the new values after executing the bulk action

Returns:

isApplicableForJobs

boolean isApplicableForJobs()

Returns whether an action is applicable for subplans

Returns:

true if applicable

isApplicable

boolean isApplicable(Plan plan)

Returns whether or not a plan is applicable for a certain bulk action, eg. only plans with svn repositories for an action updating svn details

Returns:

true if applicable

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
                              ActionParametersMap actionParameters,
                              @NotNull
                              Plan plan)

Provides possibility to populate action parameters before executing bulk action.

Parameters:

actionParameters - Action parameters to be populated

plan - Plan which will be subject to action