public class

BulkEditMultiSelectFieldBeanImpl

extends Object
implements BulkEditMultiSelectFieldBean
java.lang.Object
   ↳ com.atlassian.jira.web.bean.BulkEditMultiSelectFieldBeanImpl

Class Overview

Used in the BulkEdit Wizard. Stores the change mode options' values selected for the multi-select/multiple values system fields (Labels, Affects Versions, Fix Versions, Components). The change mode options are available in the BulkEditMultiSelectFieldOption

Summary

Constants
String ADD_ID
String CHANGE_MODE_FIELD_PREFIX
String REMOVEALL_ID
String REMOVE_ID
String REPLACE_ID
Fields
public static final List<String> BULK_EDIT_FIELDS_WITH_CHANGE_MODE_SELECTION List representing Multi-Select System Fields for which user should be able to select change mode.
public static final BulkEditMultiSelectFieldOption addOption
public Map<String, BulkEditMultiSelectFieldOption> changeModeOptions
public static final Map<String, BulkEditMultiSelectFieldOption> multiSelectChangeModeOptions
public static final BulkEditMultiSelectFieldOption removeAllOption
public static final BulkEditMultiSelectFieldOption removeOption
public static final BulkEditMultiSelectFieldOption replaceOption
Public Constructors
BulkEditMultiSelectFieldBeanImpl()
Public Methods
String getChangeModeFieldName(OrderableField field)
Returns the field name to be used in template for the change mode selection for the multi-select/multiple values system field.
Option<BulkEditMultiSelectFieldOption> getChangeModeForField(OrderableField field)
Returns the BulkEditMultiSelectFieldOption for the multi-select/multiple values system field or null in case the field is not multi-select/multiple values system field
BulkEditMultiSelectFieldOption getChangeModeOptionById(String id)
Returns change mode option for given option id.
Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions()
Returns list of change mode options which are available for Multi-Select System Fields.
BulkEditMultiSelectFieldOption getDefaultChangeModeOption()
Returns the default change mode option for multi-select/multiple values system field.
String getMultiSelectFieldActionDescription(OrderableField field)
Returns I18n key representing action description for field for Bulk Edit Wizard Confirmation screen.
boolean isChangeModeSelectionAllowed(OrderableField field)
Checks if the change mode selection is allowed for the field.
void setChangeModeForField(OrderableField field, BulkEditMultiSelectFieldOption changeMode)
Sets the change mode for multi-select/multiple values system field.
void setChangeModeFromParams(OrderableField field, Map<String, String[]> params)
Sets the change mode for the multi-select/multiple values system field from the Map of parameters.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.web.bean.BulkEditMultiSelectFieldBean

Constants

public static final String ADD_ID

Constant Value: "add"

public static final String CHANGE_MODE_FIELD_PREFIX

Constant Value: "change"

public static final String REMOVEALL_ID

Constant Value: "removeall"

public static final String REMOVE_ID

Constant Value: "remove"

public static final String REPLACE_ID

Constant Value: "replace"

Fields

public static final List<String> BULK_EDIT_FIELDS_WITH_CHANGE_MODE_SELECTION

List representing Multi-Select System Fields for which user should be able to select change mode.

public static final BulkEditMultiSelectFieldOption addOption

public Map<String, BulkEditMultiSelectFieldOption> changeModeOptions

public static final Map<String, BulkEditMultiSelectFieldOption> multiSelectChangeModeOptions

public static final BulkEditMultiSelectFieldOption removeAllOption

public static final BulkEditMultiSelectFieldOption removeOption

public static final BulkEditMultiSelectFieldOption replaceOption

Public Constructors

public BulkEditMultiSelectFieldBeanImpl ()

Public Methods

public String getChangeModeFieldName (OrderableField field)

Returns the field name to be used in template for the change mode selection for the multi-select/multiple values system field.

Parameters
field The field for which field name is retrieved.

public Option<BulkEditMultiSelectFieldOption> getChangeModeForField (OrderableField field)

Returns the BulkEditMultiSelectFieldOption for the multi-select/multiple values system field or null in case the field is not multi-select/multiple values system field

Parameters
field The field for which change mode option is retrieved.
Returns

public BulkEditMultiSelectFieldOption getChangeModeOptionById (String id)

Returns change mode option for given option id.

Parameters
id The option id for which BulkEditMultiSelectFieldOption is retrieved.
Returns

public Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions ()

Returns list of change mode options which are available for Multi-Select System Fields.

Returns

public BulkEditMultiSelectFieldOption getDefaultChangeModeOption ()

Returns the default change mode option for multi-select/multiple values system field.

Returns

public String getMultiSelectFieldActionDescription (OrderableField field)

Returns I18n key representing action description for field for Bulk Edit Wizard Confirmation screen.

Parameters
field The field for which action description is retrieved.
Returns
  • I18n key representing action description

public boolean isChangeModeSelectionAllowed (OrderableField field)

Checks if the change mode selection is allowed for the field. Returns true if the field is multi-select/multiple values system field (defined in BulkEditMultiSelectFieldBean). Returns false in all other cases.

Parameters
field The field for which change mode selection allowance is retrieved.

public void setChangeModeForField (OrderableField field, BulkEditMultiSelectFieldOption changeMode)

Sets the change mode for multi-select/multiple values system field.

Parameters
field The field for which change mode is set.
changeMode option to be set for field. The options defined by BulkEditMultiSelectFieldOption
Throws
IllegalArgumentException in case field is not multi-select/multiple values system field

public void setChangeModeFromParams (OrderableField field, Map<String, String[]> params)

Sets the change mode for the multi-select/multiple values system field from the Map of parameters. The parameters contain key-value pairs where the key is fieldId and the value is change mode option name.

Parameters
field The field for which change mode option is set.
params The map of parameters where the key is fieldId and the value is change mode option name
Throws
IllegalArgumentException in case the field is not multi-select/multiple values system field