Summary: Methods | [Expand All]
@ExperimentalApi public interface

BulkEditMultiSelectFieldBean

com.atlassian.jira.web.bean.BulkEditMultiSelectFieldBean
Known Indirect Subclasses

@ExperimentalApi

This interface is considered usable by external developers but its contracts have not stabilized.

Experimental APIs may be changed at any time before being marked @Internal or @PublicApi.

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

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 the change mode option for option id.
Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions()
Returns the list of change mode options which are available for the multi-select/multiple values system field.
BulkEditMultiSelectFieldOption getDefaultChangeModeOption()
Returns the default change mode option for multi-select/multiple values system field.
String getMultiSelectFieldActionDescription(OrderableField field)
Returns the action description for multi-select/multiple values system field based on set change mode for Bulk Edit 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.

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 the change mode option for option id.

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

public Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions ()

Returns the list of change mode options which are available for the multi-select/multiple values system field.

Returns

public BulkEditMultiSelectFieldOption getDefaultChangeModeOption ()

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

Returns

public String getMultiSelectFieldActionDescription (OrderableField field)

Returns the action description for multi-select/multiple values system field based on set change mode for Bulk Edit confirmation screen.

Parameters
field The field for which action description is retrieved.
Returns
  • The action description for multi-select/multiple values system field based on set change mode option.

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