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 Summary
 java.util.List<BuildResultsSummary> getBuildResultsForAgent(java.lang.Long agentId)
          Obtain a collection of BuildResultsSummary for a specified agentId.
 java.util.List<BuildResultsSummary> getBuildResultsForBuild(Buildable buildable)
          Deprecated. 
 java.lang.String getCookieKey()
          The key to store in the cookie.
 java.lang.String getLabel()
          The filter's label in the gui
 java.util.List<ResultsSummary> getResultsForPlan(Plan plan)
          Obtain a collection of ResultsSummary for the specified plan The number returned will depend on the filter applied.
 

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:
the cookie key for this filter.

getBuildResultsForBuild

@Deprecated
@NotNull
java.util.List<BuildResultsSummary> getBuildResultsForBuild(@Nullable
                                                                               Buildable buildable)
Deprecated. 

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

java.util.List<ResultsSummary> getResultsForPlan(@Nullable
                                                 Plan 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
java.util.List<BuildResultsSummary> getBuildResultsForAgent(java.lang.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


Copyright © 2010 Atlassian. All Rights Reserved.