Package com.atlassian.jira.issue.fields.screen

Interface FieldScreenManager

All Known Implementing Classes:
DefaultFieldScreenManager
@PublicApi public interface FieldScreenManager
Copyright (c) 2002-2004 All rights reserved.

  • Method Details

    • getFieldScreen

      FieldScreen getFieldScreen(Long id)

    • getFieldScreens

      Collection<FieldScreen> getFieldScreens()

    • getFieldScreens

      @ExperimentalApi Collection<FieldScreen> getFieldScreens(String searchQuery)
      Parameters:
      searchQuery - - search phrase which screen's name or description may contain
      Returns:
      collection of screens matching the given search phrase
      Since:
      v8.19

    • getFieldScreens

      @ExperimentalApi Collection<FieldScreen> getFieldScreens(int startIndex, int count)
      Parameters:
      startIndex - - index where every screen that has its index lower than startIndex will be discarded
      count - - upper limit of screens to return
      Returns:
      collection of screens which index is higher than startIndex, limited to specific amount
      Since:
      v8.19

    • getFieldScreens

      @ExperimentalApi Collection<FieldScreen> getFieldScreens(int startIndex, int count, String searchQuery)
      Parameters:
      startIndex - - index where every screen that matches the search query has its index lower than startIndex will be discarded
      count - - upper limit of screens with matching search query to return
      searchQuery - - search phrase which screen's name or description may contain
      Returns:
      collection of screens matching the given search phrase and which index is higher than startIndex, limited to specific amount
      Since:
      v8.19

    • getFieldScreenTabs

      Collection<FieldScreenTab> getFieldScreenTabs(String fieldId)

    • streamFieldScreenTabs

      @ExperimentalApi default Stream<FieldScreenTab> streamFieldScreenTabs(String fieldId)
      Returns a stream of field screen tabs for the given field id.
      Parameters:
      fieldId - - id of the field for which field screen tabs will be returned
      Returns:

    • createFieldScreen

      void createFieldScreen(FieldScreen fieldScreen)

    • updateFieldScreen

      void updateFieldScreen(FieldScreen fieldScreen)

    • removeFieldScreen

      void removeFieldScreen(Long id)

    • createFieldScreenTab

      void createFieldScreenTab(FieldScreenTab fieldScreenTab)

    • updateFieldScreenTab

      void updateFieldScreenTab(FieldScreenTab fieldScreenTab)

    • removeFieldScreenTabs

      void removeFieldScreenTabs(FieldScreen fieldScreen)

    • removeFieldScreenTab

      void removeFieldScreenTab(Long id)

    • getFieldScreenTabs

      List<FieldScreenTab> getFieldScreenTabs(FieldScreen fieldScreen)

    • createFieldScreenLayoutItem

      void createFieldScreenLayoutItem(FieldScreenLayoutItem fieldScreenLayoutItem)

    • updateFieldScreenLayoutItem

      void updateFieldScreenLayoutItem(FieldScreenLayoutItem fieldScreenLayoutItem)

    • removeFieldScreenLayoutItem

      void removeFieldScreenLayoutItem(FieldScreenLayoutItem fieldScreenLayoutItem)

    • removeFieldScreenLayoutItems

      void removeFieldScreenLayoutItems(FieldScreenTab fieldScreenTab)

    • getFieldScreenLayoutItems

      List<FieldScreenLayoutItem> getFieldScreenLayoutItems(FieldScreenTab fieldScreenTab)

    • removeFieldScreenItems

      void removeFieldScreenItems(String fieldId)

    • refresh

      void refresh()

    • buildNewFieldScreenLayoutItem

      FieldScreenLayoutItem buildNewFieldScreenLayoutItem(String fieldId)

    • getFieldScreenTab

      FieldScreenTab getFieldScreenTab(Long fieldScreenTabId)

    • screenNameExists

      boolean screenNameExists(String name)

    • screenNameOrDescriptionContains

      boolean screenNameOrDescriptionContains(FieldScreen fieldScreen, String phrase)
      Parameters:
      fieldScreen - - field screens on which phrase search will be performed
      phrase - - search phrase that field screen's name or description should contain
      Returns:
      boolean indicating whether search phrase is present in field screen or not
      Since:
      v8.19