com.atlassian.bamboo.builder.resultsfilter
Interface BuildResultsFilter

All Known Implementing Classes:
AllBuildResultsFilter, LatestTwentyFiveBuildResultsFilter, ThisMonthsBuildResultsFilter, TimeAgoBuildResultsFilter, TodaysBuildResultsFilter

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 Summary
 java.util.List<BuildResultsSummary> getBuildResultsForBuild(Build build)
          Obtain a collection of BuildResultsSummary for a specified build.
 java.lang.String getCookieKey()
          The key to store in the cookie.
 java.lang.String getLabel()
          The filter's label in the gui
 

Method Detail

getLabel

java.lang.String getLabel()
The filter's label in the gui

Returns:
The text to appear in the web drop down

getCookieKey

java.lang.String getCookieKey()
The key to store in the cookie.

Returns:

getBuildResultsForBuild

@NotNull
java.util.List<BuildResultsSummary> getBuildResultsForBuild(Build build)
Obtain a collection of BuildResultsSummary for a specified build. The number returned will depend on the filter applied.

Parameters:
build - The build we're interested in
Returns:
The filtered list of build result summaries


Copyright © 2009 Atlassian Pty Ltd. All Rights Reserved.