com.atlassian.bamboo.chains
Interface ChainResult

All Superinterfaces:

BambooObject

All Known Implementing Classes:

ChainResultImpl

public interface ChainResult
extends BambooObject

Represents an execution result of a Chain

Method Summary

boolean	addStageResult(ChainStageResult chainStageResult) Add a stage result
ChainStageResult	create(java.lang.String name, java.lang.String description) Create a new ChainStageResult and associates it with the ChainResult
BuildState	getBuildState() Gets the BuildState of the Chain
Chain	getChain() Get Chain
int	getChainBuildNumber() Get Chain result number
PlanResultKey	getPlanResultKey() Gets the PlanResultKey for this ChainResult
java.lang.String	getResultKey() Get the Chain result key (eg BUILD-CHAIN-123)
java.util.List<ChainStageResult>	getStageResults() Get all the ChainStageResult's associated with this ChainResult
boolean	isFailed() Is the chain execution a failure?
boolean	isPending() Is the chain execution still pending?
boolean	isSuccessful() Is the chain execution successful?
boolean	removeStageResult(ChainStageResult chainStageResult) Remove a stage result
void	setBuildState(BuildState buildState) Sets the BuildState of the Chain
void	setChain(Chain chain) Set Chain
void	setChainBuildNumber(int number) Set the Chain result number

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

getId, setId

Method Detail

getPlanResultKey

@NotNull
PlanResultKey getPlanResultKey()

Gets the PlanResultKey for this ChainResult

Returns:

planResultKey

isSuccessful

boolean isSuccessful()

Is the chain execution successful?

Returns:

successful

isFailed

boolean isFailed()

Is the chain execution a failure?

Returns:

failure

isPending

boolean isPending()

Is the chain execution still pending?

Returns:

getBuildState

BuildState getBuildState()

Gets the BuildState of the Chain

Returns:

buildState

setBuildState

void setBuildState(BuildState buildState)

Sets the BuildState of the Chain

Parameters:

buildState -

getChainBuildNumber

int getChainBuildNumber()

Get Chain result number

Returns:

num

setChainBuildNumber

void setChainBuildNumber(int number)

Set the Chain result number

Parameters:

number -

getChain

@NotNull
Chain getChain()

Get Chain

Returns:

chain

getResultKey

java.lang.String getResultKey()

Get the Chain result key (eg BUILD-CHAIN-123)

Returns:

resultKey

setChain

void setChain(@NotNull
              Chain chain)

Set Chain

Parameters:

chain -

getStageResults

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

Get all the ChainStageResult's associated with this ChainResult

Returns:

results

create

@NotNull
ChainStageResult create(java.lang.String name,
                                java.lang.String description)

Create a new ChainStageResult and associates it with the ChainResult

Parameters:

name - name of the Stage related to result

description - decription of the Stage releated 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