com.atlassian.jira.web.bean

Class BulkEditMultiSelectFieldBeanImpl

java.lang.Object

com.atlassian.jira.web.bean.BulkEditMultiSelectFieldBeanImpl

All Implemented Interfaces:

BulkEditMultiSelectFieldBean

public class BulkEditMultiSelectFieldBeanImpl
extends Object
implements BulkEditMultiSelectFieldBean

Used in the BulkEdit Wizard. Stores the change mode option values selected for the configured system fields. The change mode options are available in the BulkEditMultiSelectFieldOption

Since:

v6.4

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_MODE_FIELD_PREFIX
static Map<String,BulkEditMultiSelectFieldOption>	CHANGE_MODE_LOOKUP
static Map<String,BulkEditMultiSelectFieldOption>	DEFAULT_CHANGE_MODES
static Set<BulkEditMultiSelectFieldOption>	MULTI_SELECT_CHANGE_MODES
static BulkEditMultiSelectFieldOption	MULTI_SELECT_FIELD_OPTION_ADD
static BulkEditMultiSelectFieldOption	MULTI_SELECT_FIELD_OPTION_REMOVE
static BulkEditMultiSelectFieldOption	MULTI_SELECT_FIELD_OPTION_REMOVE_ALL
static BulkEditMultiSelectFieldOption	MULTI_SELECT_FIELD_OPTION_REPLACE
static Map<String,Set<BulkEditMultiSelectFieldOption>>	SYSTEM_FIELD_CHANGE_MODES
static Set<BulkEditMultiSelectFieldOption>	TEXT_CHANGE_MODES
static BulkEditMultiSelectFieldOption	TEXT_FIELD_OPTION_ADD_AFTER
static BulkEditMultiSelectFieldOption	TEXT_FIELD_OPTION_ADD_BEFORE
static BulkEditMultiSelectFieldOption	TEXT_FIELD_OPTION_REPLACE

Constructor Summary

Constructors

Constructor and Description
BulkEditMultiSelectFieldBeanImpl()

Method Summary

Modifier and Type	Method and Description
String	getChangeModeFieldName(OrderableField field) Returns the field name to be used in template for the change mode selection for the system field.
io.atlassian.fugue.Option<BulkEditMultiSelectFieldOption>	getChangeModeForField(OrderableField field) Returns the BulkEditMultiSelectFieldOption for the system field or null in case the field does not have multiple change modes configured.
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 system field.
Collection<BulkEditMultiSelectFieldOption>	getChangeModeOptionsForField(OrderableField<?> field) Returns the list of change mode options which are available for the given system field.
BulkEditMultiSelectFieldOption	getDefaultChangeModeOption() Returns the default change mode option for the field.
BulkEditMultiSelectFieldOption	getDefaultChangeModeOptionForField(OrderableField<?> field) Returns the default change mode option for the given field.
String	getMultiSelectFieldActionDescription(OrderableField field) Returns the action description for the 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.
boolean	isChangeModeSelectionAllowed(OrderableField<?> field, String changeModeId) Checks if the given change mode selection is valid for the field.
void	setChangeModeForField(OrderableField field, BulkEditMultiSelectFieldOption changeMode) Sets the change mode for the system field.
void	setChangeModeFromParams(OrderableField field, Map<String,String[]> params) Sets the change mode for the system field from the Map of parameters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CHANGE_MODE_FIELD_PREFIX

public static final String CHANGE_MODE_FIELD_PREFIX

See Also:

Constant Field Values

MULTI_SELECT_FIELD_OPTION_ADD

public static final BulkEditMultiSelectFieldOption MULTI_SELECT_FIELD_OPTION_ADD

MULTI_SELECT_FIELD_OPTION_REMOVE

public static final BulkEditMultiSelectFieldOption MULTI_SELECT_FIELD_OPTION_REMOVE

MULTI_SELECT_FIELD_OPTION_REPLACE

public static final BulkEditMultiSelectFieldOption MULTI_SELECT_FIELD_OPTION_REPLACE

MULTI_SELECT_FIELD_OPTION_REMOVE_ALL

public static final BulkEditMultiSelectFieldOption MULTI_SELECT_FIELD_OPTION_REMOVE_ALL

TEXT_FIELD_OPTION_ADD_AFTER

public static final BulkEditMultiSelectFieldOption TEXT_FIELD_OPTION_ADD_AFTER

TEXT_FIELD_OPTION_ADD_BEFORE

public static final BulkEditMultiSelectFieldOption TEXT_FIELD_OPTION_ADD_BEFORE

TEXT_FIELD_OPTION_REPLACE

public static final BulkEditMultiSelectFieldOption TEXT_FIELD_OPTION_REPLACE

CHANGE_MODE_LOOKUP

public static final Map<String,BulkEditMultiSelectFieldOption> CHANGE_MODE_LOOKUP

MULTI_SELECT_CHANGE_MODES

public static final Set<BulkEditMultiSelectFieldOption> MULTI_SELECT_CHANGE_MODES

TEXT_CHANGE_MODES

public static final Set<BulkEditMultiSelectFieldOption> TEXT_CHANGE_MODES

SYSTEM_FIELD_CHANGE_MODES

public static final Map<String,Set<BulkEditMultiSelectFieldOption>> SYSTEM_FIELD_CHANGE_MODES

DEFAULT_CHANGE_MODES

public static final Map<String,BulkEditMultiSelectFieldOption> DEFAULT_CHANGE_MODES

Constructor Detail

BulkEditMultiSelectFieldBeanImpl

public BulkEditMultiSelectFieldBeanImpl()

Method Detail

isChangeModeSelectionAllowed

public boolean isChangeModeSelectionAllowed(OrderableField field)

Description copied from interface: BulkEditMultiSelectFieldBean

Checks if the change mode selection is allowed for the field. Returns true if the field is configured to allow multiple change modes. Returns false in all other cases.

Specified by:

isChangeModeSelectionAllowed in interface BulkEditMultiSelectFieldBean

Parameters:

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

isChangeModeSelectionAllowed

public boolean isChangeModeSelectionAllowed(OrderableField<?> field,
                                            String changeModeId)

Description copied from interface: BulkEditMultiSelectFieldBean

Checks if the given change mode selection is valid for the field. Returns true if the field is configured to allow this change mode. Returns false in all other cases.

Specified by:

isChangeModeSelectionAllowed in interface BulkEditMultiSelectFieldBean

Parameters:

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

getChangeModeFieldName

public String getChangeModeFieldName(OrderableField field)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the field name to be used in template for the change mode selection for the system field.

Specified by:

getChangeModeFieldName in interface BulkEditMultiSelectFieldBean

Parameters:

field - The field for which field name is retrieved.

setChangeModeForField

public void setChangeModeForField(OrderableField field,
                                  BulkEditMultiSelectFieldOption changeMode)
                           throws IllegalArgumentException

Description copied from interface: BulkEditMultiSelectFieldBean

Sets the change mode for the system field.

Specified by:

setChangeModeForField in interface BulkEditMultiSelectFieldBean

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 the field does not have change modes configured.

getChangeModeForField

public io.atlassian.fugue.Option<BulkEditMultiSelectFieldOption> getChangeModeForField(OrderableField field)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the BulkEditMultiSelectFieldOption for the system field or null in case the field does not have multiple change modes configured.

Specified by:

getChangeModeForField in interface BulkEditMultiSelectFieldBean

Parameters:

field - The field for which change mode option is retrieved.

Returns:

BulkEditMultiSelectFieldOption set for the field or null

setChangeModeFromParams

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

Description copied from interface: BulkEditMultiSelectFieldBean

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

Specified by:

setChangeModeFromParams in interface BulkEditMultiSelectFieldBean

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 does not have multiple change modes configured.

getChangeModeOptions

public Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions()

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the list of change mode options which are available for the system field.

Specified by:

getChangeModeOptions in interface BulkEditMultiSelectFieldBean

Returns:

The list of BulkEditMultiSelectFieldOption to be visible in the Bulk Edit Wizard

getChangeModeOptionsForField

public Collection<BulkEditMultiSelectFieldOption> getChangeModeOptionsForField(OrderableField<?> field)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the list of change mode options which are available for the given system field.

Specified by:

getChangeModeOptionsForField in interface BulkEditMultiSelectFieldBean

Parameters:

field - The system field in question.

Returns:

The list of BulkEditMultiSelectFieldOption to be visible in the Bulk Edit Wizard

getDefaultChangeModeOption

public BulkEditMultiSelectFieldOption getDefaultChangeModeOption()

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the default change mode option for the field.

Specified by:

getDefaultChangeModeOption in interface BulkEditMultiSelectFieldBean

Returns:

BulkEditMultiSelectFieldOption which is the default for the Bulk Edit Wizard

getDefaultChangeModeOptionForField

public BulkEditMultiSelectFieldOption getDefaultChangeModeOptionForField(OrderableField<?> field)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the default change mode option for the given field.

Specified by:

getDefaultChangeModeOptionForField in interface BulkEditMultiSelectFieldBean

Parameters:

field - The system field to check the default change mode for.

Returns:

The BulkEditMultiSelectFieldOption which is the default for the given field in the Bulk Edit Wizard

getChangeModeOptionById

public BulkEditMultiSelectFieldOption getChangeModeOptionById(String id)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the change mode option for option id.

Specified by:

getChangeModeOptionById in interface BulkEditMultiSelectFieldBean

Parameters:

id - The option id for which BulkEditMultiSelectFieldOption is retrieved.

Returns:

BulkEditMultiSelectFieldOption which is the default for the Bulk Edit Wizard

getMultiSelectFieldActionDescription

public String getMultiSelectFieldActionDescription(OrderableField field)

Description copied from interface: BulkEditMultiSelectFieldBean

Returns the action description for the field based on set change mode for Bulk Edit confirmation screen.

Specified by:

getMultiSelectFieldActionDescription in interface BulkEditMultiSelectFieldBean

Parameters:

field - The field for which action description is retrieved.

Returns:

The action description for the field based on set change mode option.