com.atlassian.bamboo.resultsummary.search

Interface PlanResultSearcher

All Known Implementing Classes:

PlanResultSearcherImpl

@ExperimentalApi
public interface PlanResultSearcher

Utility service that provides searching through ResultsSummary objects. As a rule, specs results are excluded from the search results.

Since:

8.2

Method Summary

Modifier and Type	Method and Description
@NotNull long	countByJiraCriteria(@NotNull ByJiraIssueResultSearchCriteria jiraCriteria, @NotNull ResultSummarySearchCriteria criteria)
<T extends ResultsSummary> @NotNull List<T>	findByAuthors(@NotNull Collection<ExtendedAuthor> authors, @NotNull Class<T> resultClass, int maxResults) Find result of a given class by given author list.
@NotNull List<ResultsSummary>	findByCriteria(@NotNull ResultSummarySearchCriteria criteria) Searches for any ResultsSummary object given a ResultSummarySearchCriteria.
<T extends ResultsSummary> @NotNull List<T>	findByCriteria(@NotNull ResultSummarySearchCriteria criteria, @NotNull Class<T> resultClass) Searches for any ResultsSummary object given a ResultSummarySearchCriteria.
@NotNull List<ChainResultsSummary>	findByJiraCriteria(@NotNull ByJiraIssueResultSearchCriteria jiraCriteria, @NotNull ResultSummarySearchCriteria criteria)
<T extends PlanKeyProvider> @NotNull List<T>	findByJiraCriteriaAndTransform(@NotNull ByJiraIssueResultSearchCriteria jiraCriteria, @NotNull ResultSummarySearchCriteria criteria, @NotNull Function<ChainResultsSummary,T> transformation) Find ChainResultsSummary relevant to given set of Jira issue keys and apply transformation.
@Nullable ChainResultsSummary	findLatestRelevantBuildResult(@NotNull PlanKey planKey, long beforeLastCompletedTimestamp) Find the last finished build of a plan that completed before given time

Method Detail

findByAuthors

@NotNull
<T extends ResultsSummary> @NotNull List<T> findByAuthors(@NotNull
                                                                   @NotNull Collection<ExtendedAuthor> authors,
                                                                   @NotNull
                                                                   @NotNull Class<T> resultClass,
                                                                   int maxResults)

Find result of a given class by given author list.

findByCriteria

@NotNull
@NotNull List<ResultsSummary> findByCriteria(@NotNull
                                                      @NotNull ResultSummarySearchCriteria criteria)

Searches for any ResultsSummary object given a ResultSummarySearchCriteria. Results are either sorted by build date (newest first) or unordered.

findByCriteria

@NotNull
<T extends ResultsSummary> @NotNull List<T> findByCriteria(@NotNull
                                                                    @NotNull ResultSummarySearchCriteria criteria,
                                                                    @NotNull
                                                                    @NotNull Class<T> resultClass)

Searches for any ResultsSummary object given a ResultSummarySearchCriteria. Results are either sorted by build date (newest first) or unordered.

findByJiraCriteria

@NotNull
@NotNull List<ChainResultsSummary> findByJiraCriteria(@NotNull
                                                               @NotNull ByJiraIssueResultSearchCriteria jiraCriteria,
                                                               @NotNull
                                                               @NotNull ResultSummarySearchCriteria criteria)

countByJiraCriteria

@NotNull
@NotNull long countByJiraCriteria(@NotNull
                                           @NotNull ByJiraIssueResultSearchCriteria jiraCriteria,
                                           @NotNull
                                           @NotNull ResultSummarySearchCriteria criteria)

findByJiraCriteriaAndTransform

@NotNull
<T extends PlanKeyProvider> @NotNull List<T> findByJiraCriteriaAndTransform(@NotNull
                                                                                     @NotNull ByJiraIssueResultSearchCriteria jiraCriteria,
                                                                                     @NotNull
                                                                                     @NotNull ResultSummarySearchCriteria criteria,
                                                                                     @NotNull
                                                                                     @NotNull Function<ChainResultsSummary,T> transformation)

Find ChainResultsSummary relevant to given set of Jira issue keys and apply transformation.

Returns:

List of transformed objects

findLatestRelevantBuildResult

@Nullable
@Nullable ChainResultsSummary findLatestRelevantBuildResult(@NotNull
                                                                      @NotNull PlanKey planKey,
                                                                      long beforeLastCompletedTimestamp)

Find the last finished build of a plan that completed before given time

Parameters:

planKey - Plan to filter build results

beforeLastCompletedTimestamp - timestamp

Returns:

ResultSummary of null if there's no finished build before given time