Package com.atlassian.bamboo.builder.resultsfilter

Interface BuildResultsFilter

All Known Implementing Classes:
AllBuildResultsFilter, Latest25FiveBuildResultsFilter, TimeAgoBuildResultsFilter
public interface BuildResultsFilter
This interface represents a filter for selecting which of a build's BuildResultsSummary objects a user would like to see displayed.

  • Method Details

    • getLabel

      String getLabel()
      The filter's label in the gui
      Returns:
      The text to appear in the web drop down

    • getCookieKey

      String getCookieKey()
      The key to store in the cookie.
      Returns:
      the cookie key for this filter.

    • getBuildResultsForBuild

      @Deprecated @NotNull @NotNull List<BuildResultsSummary> getBuildResultsForBuild(@Nullable @Nullable ImmutableBuildable buildable)
      Deprecated.
      since 2.7 use getResultsForPlan(ImmutablePlan) instead
      Obtain a collection of BuildResultsSummary for a specified build. The number returned will depend on the filter applied.
      Parameters:
      buildable - - plan to get results for
      Returns:
      The filtered list of build result summaries

    • getResultsForPlan

      @NotNull @NotNull List<ResultsSummary> getResultsForPlan(@Nullable @Nullable ImmutablePlan plan)
      Obtain a collection of ResultsSummary for the specified plan The number returned will depend on the filter applied.
      Parameters:
      plan - to get results for
      Returns:
      The filtered list of build result summaries

    • getBuildResultsForAgent

      @NotNull @NotNull List<BuildResultsSummary> getBuildResultsForAgent(Long agentId)
      Obtain a collection of BuildResultsSummary for a specified agentId. The number returned will depend on the filter applied.
      Parameters:
      agentId - if of an agent
      Returns:
      The filtered list of build result summaries

    • getFromBuildNumber

      int getFromBuildNumber(@NotNull @NotNull PlanKey planKey)
      The build number (inclusive) that extrenal callers can use to filter for a given plan. 0 if not filtered by number
      Parameters:
      planKey -
      Returns:

    • getFromDate

      @Nullable @Nullable Date getFromDate()
      Lower bound date to filter by. Null if not a date filter
      Returns: