com.atlassian.bamboo.chains
Interface ChainResultsSummary

All Superinterfaces:

BambooIdProvider, BambooObject, java.lang.Comparable<ResultsSummary>, Deletable, ImmutableDeletable, ResultsSummary, ResultStatisticsProvider

All Known Implementing Classes:

ChainResultsSummaryDocument, ChainResultsSummaryImpl, ImmutableResultsSummary

public interface ChainResultsSummary
extends ResultsSummary

Represents an execution result of a Chain

Method Summary

boolean	addStageResult(ChainStageResult chainStageResult) Add a stage result
ChainStageResult	createStageResult(ImmutableChainStage 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
MergeResultSummary	getMergeResult() Note: this API is experimental.
java.util.List<ResultsSummary>	getOrderedJobResultSummaries() Returns all jobs ResultsSummary related to chain result summary Summaries are ordered by stages
Chain	getPlan() Gets the Plan that this result belongs directly belongs to
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	isContinuable() Indicates that Chain execution has been stopped on manual stage and is waiting for user action
boolean	isRestartable() Indicates that Chain execution has been failed and could be restarted from failure place
boolean	removeStageResult(ChainStageResult chainStageResult) Remove a stage result
void	setContinuable(boolean continuable)
void	setMergeResult(MergeResultSummary mergeResult) Note: this API is experimental.

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

getArtifactLinks, getArtifactLinksThatExist, getBuildAgentId, getBuildCancelledDate, getBuildCompletedDate, getBuildKey, getBuildResultKey, getBuildTime, getChangesListSummary, getComments, getCommentsToDisplay, getCommits, getCustomBuildData, getDeltaState, getDuration, getDurationDescription, getFixingJiraIssues, getJiraIssueKeys, getJiraIssues, getLabellings, getLabelNames, getLifeCycleState, getManuallyOverriddenVariables, getPlanCompletedDate, getPlanKey, getPlanResultKey, getProcessingDuration, getProcessingDurationDescription, getQueueTime, getReasonSummary, getRelatedJiraIssues, getRelativeBuildDate, getRelativeBuildDate, getRelativeBuildStartedDate, getRelativeBuildStartedDate, getRelativeQueueDate, getRelativeQueueDate, getRepositoryChangesets, getRestartCount, getShortReasonSummary, getSubscriptions, getSubstitutedVariables, getTestResultsSummary, getTestSummary, getTimeToFix, getTriggerReason, getUniqueAuthors, getVariableContextLogs, hasChanges, hasComments, hasCommentsToDisplay, incrementRestartCount, isActive, isFailed, isFinished, isInProgress, isNotBuilt, isNotRunYet, isPending, isQueued, isSuccessful, isWaiting, resetTestClassResults, setBuildAgentId, setBuildCancelledDate, setBuildCompletedDate, setBuildDate, setDeltaState, setDuration, setPlanCompletedDate, setProcessingDuration, setQueueTime, setTestResultsSummary, setTimeToFix, setTriggerReason, updateLifeCycleState

Methods inherited from interface com.atlassian.bamboo.deletion.Deletable

setMarkedForDeletion

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

setId

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

getId

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable

isMarkedForDeletion

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

getBuildDate, getBuildNumber, getBuildState, getDurationInSeconds, getStatDate

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getPlan

@NotNull
Chain getPlan()

Description copied from interface: ResultsSummary

Gets the Plan that this result belongs directly belongs to

Specified by:

getPlan in interface ResultsSummary

Returns:

the owning plan for the result

getStageResults

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

Get all the ChainStageResult's associated with this ChainResultsSummary

Returns:

results

createStageResult

@NotNull
ChainStageResult createStageResult(@NotNull
                                           ImmutableChainStage 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:

isContinuable

boolean isContinuable()

Indicates that Chain execution has been stopped on manual stage and is waiting for user action

Returns:

setContinuable

void setContinuable(boolean continuable)

isRestartable

boolean isRestartable()

Indicates that Chain execution has been failed and could be restarted from failure place

Returns:

getMergeResult

@Nullable
MergeResultSummary getMergeResult()

Note: this API is experimental.

Since:

4.0

setMergeResult

void setMergeResult(@Nullable
                    MergeResultSummary mergeResult)

Note: this API is experimental.

Parameters:

mergeResult -

Since:

4.0