com.atlassian.bamboo.chains
Interface ChainResultsSummary

All Superinterfaces:

BambooObject, java.lang.Comparable<ResultsSummary>, ResultsSummary, ResultStatisticsProvider

All Known Implementing Classes:

BuildResultsSummaryDocument, ChainResultsSummaryImpl

public interface ChainResultsSummary
extends ResultsSummary

Represents an execution result of a Chain

Method Summary

boolean	addStageResult(ChainStageResult chainStageResult) Add a stage result
ChainStageResult	createStageResult(ChainStage chainStage) Create a new ChainStageResult and associates it with the ChainResultsSummary
java.util.List<BuildResultsSummary>	getFailedJobResults() Get a list of all failed job Results in this chain result
java.util.List<ResultsSummary>	getOrderedJobResultSummaries() Returns all jobs ResultsSummary related to chain result summary Summaries are ordered by stages
java.util.List<ChainStageResult>	getStageResults() Get all the ChainStageResult's associated with this ChainResultsSummary
FilteredTestResults<TestClassResultDescriptor>	getTestResults() Get the helper class to provide filtered test lists for this chain result
int	getTotalJobCount()
boolean	removeStageResult(ChainStageResult chainStageResult) Remove a stage result

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultsSummary

getArtifactLinks, getArtifactLinksThatExist, getBuildCancelledDate, getBuildCompletedDate, getBuildKey, getBuildResultKey, getBuildTime, getChangesListSummary, getComments, getCommits, getCustomBuildData, getDeltaState, getDuration, getDurationDescription, getFailedTestCount, getFixingJiraIssues, getJiraIssueKeys, getJiraIssues, getLabellings, getLabelNames, getLifeCycleState, getPlan, getPlanCompletedDate, getPlanResultKey, getQueueTime, getReasonSummary, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getRelativeQueueDate, getRelativeQueueDate, getShortReasonSummary, getSkippedCommitsCount, getSubscriptions, getSuccessfulTestCount, getTestResultsSummary, getTestSummary, getTimeToFix, getTriggerReason, getUniqueAuthors, getVcsRevisionKey, hasChanges, hasComments, isActive, isFailed, isFinished, isInProgress, isNotBuilt, isPending, isQueued, isSuccessful, isWaiting, resetTestClassResults, setBuildCancelledDate, setBuildDate, setDeltaState, setDuration, setPlanCompletedDate, setQueueTime, setTestResultsSummary, setTimeToFix, setTriggerReason, setVcsRevisionKey, updateLifeCycleState

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

getId, setId

Methods inherited from interface com.atlassian.bamboo.resultsummary.ResultStatisticsProvider

getBuildDate, getBuildNumber, getBuildState, getDurationInSeconds, getStatDate

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getStageResults

@NotNull
java.util.List<ChainStageResult> getStageResults()

Get all the ChainStageResult's associated with this ChainResultsSummary

Returns:

results

createStageResult

@NotNull
ChainStageResult createStageResult(@NotNull
                                           ChainStage chainStage)

Create a new ChainStageResult and associates it with the ChainResultsSummary

Parameters:

chainStage - the Stage related to result

Returns:

chainStageResult

addStageResult

boolean addStageResult(@NotNull
                       ChainStageResult chainStageResult)

Add a stage result

Parameters:

chainStageResult -

Returns:

success

removeStageResult

boolean removeStageResult(@NotNull
                          ChainStageResult chainStageResult)

Remove a stage result

Parameters:

chainStageResult -

Returns:

success

getTestResults

@Nullable
FilteredTestResults<TestClassResultDescriptor> getTestResults()

Get the helper class to provide filtered test lists for this chain result

Returns:

helper class to provide filtered test lists for this chain result, null if the chain is still being built

getFailedJobResults

@NotNull
java.util.List<BuildResultsSummary> getFailedJobResults()

Get a list of all failed job Results in this chain result

Returns:

a list of all failed job Results in this chain result

getTotalJobCount

int getTotalJobCount()

Returns:

how many job results exist

getOrderedJobResultSummaries

@NotNull
java.util.List<ResultsSummary> getOrderedJobResultSummaries()

Returns all jobs ResultsSummary related to chain result summary Summaries are ordered by stages

Returns: