Package com.atlassian.bamboo.quickfilter

Interface QuickFilter

All Superinterfaces:
BambooIdProvider, BambooObject, NameProvider
All Known Implementing Classes:
QuickFilterEntity
public interface QuickFilter extends BambooObject, NameProvider
A single filter displayed on Bamboo dashboard, which allows quick filtering of plans.

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull QuickFilter
    copy()
    Returns independent copy of this quick filter.
    @NotNull String
    getName()
    Get the unique name of this quick filter.
    int
    getPosition()
    Get the position of this quick filter on the quick filters list.
    @NotNull List<QuickFilterRule>
    getRules()
    Returns a list of rules for this quick filter.
    void
    setName(@NotNull String name)
    Set quick filter's unique name.
    void
    setPosition(int position)
    Sets the position of this quick filter on the quick filters list.
    void
    setRules(@NotNull List<QuickFilterRule> rules)
    Set the rules for this quick filter.

    Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider

    getId

    Methods inherited from interface com.atlassian.bamboo.core.BambooObject

    setId

  • Method Details

    • getName

      @NotNull @NotNull String getName()
      Get the unique name of this quick filter. The name is also filter's display name.
      Specified by:
      getName in interface NameProvider
      Returns:
      quick filter name

    • setName

      void setName(@NotNull @NotNull String name)
      Set quick filter's unique name. The name is also filter's display name
      Parameters:
      name - new name of this quick filter

    • getPosition

      int getPosition()
      Get the position of this quick filter on the quick filters list. This value indicates the order of displaying filters to users. First quick filter should have position of 1.
      Returns:
      quick filter position on the list

    • setPosition

      void setPosition(int position)
      Sets the position of this quick filter on the quick filters list. This value indicates the order of displaying filters to users. First quick filter should have position of 1.
      Parameters:
      position - new quick filter position index

    • getRules

      @NotNull @NotNull List<QuickFilterRule> getRules()
      Returns a list of rules for this quick filter. Rules define whether a quick filter will or will not match a plan.
      Returns:
      quick filter rules

    • setRules

      void setRules(@NotNull @NotNull List<QuickFilterRule> rules)
      Set the rules for this quick filter. Rules define whether a quick filter will or will not match a plan.
      Parameters:
      rules - quick filter rules

    • copy

      @NotNull @NotNull QuickFilter copy()
      Returns independent copy of this quick filter.