Package com.atlassian.jira.web.bean

Interface BulkEditMultiSelectFieldBean

All Known Implementing Classes:
BulkEditMultiSelectFieldBeanImpl
@ExperimentalApi public interface BulkEditMultiSelectFieldBean
Used in the BulkEdit Wizard. Stores the change mode options' values selected for the configured system fields. The change mode options are available in the BulkEditMultiSelectFieldOption
Since:
v6.4

  • Method Details

    • isChangeModeSelectionAllowed

      boolean isChangeModeSelectionAllowed(OrderableField field)
      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.
      Parameters:
      field - The field for which change mode selection allowance is retrieved.

    • isChangeModeSelectionAllowed

      boolean isChangeModeSelectionAllowed(OrderableField<?> field, String changeModeId)
      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.
      Parameters:
      field - The field for which change mode selection allowance is retrieved.

    • getChangeModeFieldName

      String getChangeModeFieldName(OrderableField field)
      Returns the field name to be used in template for the change mode selection for the system field.
      Parameters:
      field - The field for which field name is retrieved.

    • setChangeModeForField

      void setChangeModeForField(OrderableField field, BulkEditMultiSelectFieldOption changeMode) throws IllegalArgumentException
      Sets the change mode for the 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 the field does not have change modes configured.

    • getChangeModeForField

      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.
      Parameters:
      field - The field for which change mode option is retrieved.
      Returns:
      BulkEditMultiSelectFieldOption set for the field or null

    • setChangeModeFromParams

      void setChangeModeFromParams(OrderableField field, Map<String,String[]> params) throws IllegalArgumentException
      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.
      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

      Collection<BulkEditMultiSelectFieldOption> getChangeModeOptions()
      Deprecated.
      Use getChangeModeOptionsForField(OrderableField)
      Returns the list of change mode options which are available for the system field.
      Returns:
      The list of BulkEditMultiSelectFieldOption to be visible in the Bulk Edit Wizard

    • getChangeModeOptionsForField

      Collection<BulkEditMultiSelectFieldOption> getChangeModeOptionsForField(OrderableField<?> field)
      Returns the list of change mode options which are available for the given system field.
      Parameters:
      field - The system field in question.
      Returns:
      The list of BulkEditMultiSelectFieldOption to be visible in the Bulk Edit Wizard

    • getDefaultChangeModeOption

      BulkEditMultiSelectFieldOption getDefaultChangeModeOption()
      Deprecated.
      Use getDefaultChangeModeOptionForField(OrderableField)
      Returns the default change mode option for the field.
      Returns:
      BulkEditMultiSelectFieldOption which is the default for the Bulk Edit Wizard

    • getDefaultChangeModeOptionForField

      BulkEditMultiSelectFieldOption getDefaultChangeModeOptionForField(OrderableField<?> field)
      Returns the default change mode option for the given field.
      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

      BulkEditMultiSelectFieldOption getChangeModeOptionById(String id)
      Returns the change mode option for option id.
      Parameters:
      id - The option id for which BulkEditMultiSelectFieldOption is retrieved.
      Returns:
      BulkEditMultiSelectFieldOption which is the default for the Bulk Edit Wizard

    • getMultiSelectFieldActionDescription

      String getMultiSelectFieldActionDescription(OrderableField field)
      Returns the action description for the 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 the field based on set change mode option.