Package com.atlassian.bamboo.quickfilter

Interface UserActiveQuickFilterService

All Known Implementing Classes:
UserActiveQuickFilterServiceImpl
@ThreadSafe public interface UserActiveQuickFilterService
A service for managing visible and active quick filters for users.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    activateQuickFilter(@NotNull com.atlassian.user.User user, long quickFilterId)
    Activates a quick filter for a user.
    void
    deactivateAllQuickFilters(@NotNull com.atlassian.user.User user)
    Deactivates all quick filters for a user.
    void
    deactivateQuickFilter(@NotNull com.atlassian.user.User user, long quickFilterId)
    Deactivates a quick filter for a user.
    @NotNull List<QuickFilter>
    getActiveQuickFilters(@NotNull com.atlassian.user.User user)
    Returns all active quick filters for a user.
    @NotNull List<QuickFilter>
    getVisibleQuickFilters(@NotNull com.atlassian.user.User user)
    Returns a list of quick filters which have been selected by the given user to be shown for them on Bamboo dashboard.
    void
    setVisibleQuickFilters(@NotNull com.atlassian.user.User user, @NotNull Iterable<Long> quickFilterIds)
    Sets the list of quick filters which the given user has selected to be shown for them on Bamboo dashboard.

  • Method Details

    • getVisibleQuickFilters

      @NotNull @NotNull List<QuickFilter> getVisibleQuickFilters(@NotNull @NotNull com.atlassian.user.User user)
      Returns a list of quick filters which have been selected by the given user to be shown for them on Bamboo dashboard.
      Parameters:
      user - Bamboo user
      Returns:
      a list of all quick filters that are visible for that user; might be an empty list

    • setVisibleQuickFilters

      void setVisibleQuickFilters(@NotNull @NotNull com.atlassian.user.User user, @NotNull @NotNull Iterable<Long> quickFilterIds)
      Sets the list of quick filters which the given user has selected to be shown for them on Bamboo dashboard.
      Parameters:
      user - Bamboo user
      quickFilterIds - ids of quick filters to set as visible

    • getActiveQuickFilters

      @NotNull @NotNull List<QuickFilter> getActiveQuickFilters(@NotNull @NotNull com.atlassian.user.User user)
      Returns all active quick filters for a user. Active quick filters are the ones that actually filter out plans on Bamboo dashboard.
      Parameters:
      user - Bamboo user
      Returns:
      a list of all quick filters that are active for that user; might be an empty list

    • activateQuickFilter

      void activateQuickFilter(@NotNull @NotNull com.atlassian.user.User user, long quickFilterId)
      Activates a quick filter for a user.
      Parameters:
      user - Bamboo user
      quickFilterId - id of the quick filter to set active

    • deactivateQuickFilter

      void deactivateQuickFilter(@NotNull @NotNull com.atlassian.user.User user, long quickFilterId)
      Deactivates a quick filter for a user.
      Parameters:
      user - Bamboo user
      quickFilterId - id of the quick filter to deactivate

    • deactivateAllQuickFilters

      void deactivateAllQuickFilters(@NotNull @NotNull com.atlassian.user.User user)
      Deactivates all quick filters for a user.
      Parameters:
      user - Bamboo user