com.atlassian.bamboo.chains
Interface ChainStageResult

All Superinterfaces:
BambooObject, Describable, DescriptionProvider, NameProvider
All Known Implementing Classes:
ChainStageResultImpl

public interface ChainStageResult
extends BambooObject, Describable

Represents the result of a ChainStage execution


Method Summary
 boolean addBuildResult(BuildResultsSummary buildResult)
          Adds a BuildResultsSummary and sets the relationship to the ChainResultsSummary
 java.util.Set<BuildResultsSummary> getBuildResults()
          Returns all the BuildResultsSummary with this Stage result
 ChainResultsSummary getChainResult()
          Returns the ChainResultsSummary associated with this Stage result
 java.util.Collection<BuildResultsSummary> getFailedBuildResults()
          Returns all the failed BuildResultsSummary with this Stage result
 LifeCycleState getLifeCycleState()
           
 java.util.List<BuildResultsSummary> getSortedBuildResults()
          Returns all the BuildResultsSummary with this Stage result ordered by build name.
 BuildState getState()
           
 java.util.Collection<BuildResultsSummary> getSuccessfulBuildResults()
          Returns all the successful BuildResultsSummary with this Stage result
 boolean isCompleted()
           
 boolean isFailed()
           
 boolean isFinished()
           
 boolean isPending()
           
 boolean isSuccessful()
           
 boolean removeBuildResult(BuildResultsSummary buildResult)
          Removes a BuildResultsSummary
 void setChainResult(ChainResultsSummary chainResult)
          Sets the ChainResultsSummary associated with this Stage result
 
Methods inherited from interface com.atlassian.bamboo.core.BambooObject
getId, setId
 
Methods inherited from interface com.atlassian.bamboo.Describable
setDescription, setName
 
Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider
getDescription, getName
 

Method Detail

getChainResult

@NotNull
ChainResultsSummary getChainResult()
Returns the ChainResultsSummary associated with this Stage result

Returns:
chainResult

setChainResult

void setChainResult(@NotNull
                    ChainResultsSummary chainResult)
Sets the ChainResultsSummary associated with this Stage result

Parameters:
chainResult -

getBuildResults

@NotNull
java.util.Set<BuildResultsSummary> getBuildResults()
Returns all the BuildResultsSummary with this Stage result

Returns:
results

getSortedBuildResults

@NotNull
java.util.List<BuildResultsSummary> getSortedBuildResults()
Returns all the BuildResultsSummary with this Stage result ordered by build name. WARNING: Dont use in performance critical situations.

Returns:
results

getFailedBuildResults

@NotNull
java.util.Collection<BuildResultsSummary> getFailedBuildResults()
Returns all the failed BuildResultsSummary with this Stage result

Returns:
results

getSuccessfulBuildResults

@NotNull
java.util.Collection<BuildResultsSummary> getSuccessfulBuildResults()
Returns all the successful BuildResultsSummary with this Stage result

Returns:
results

addBuildResult

boolean addBuildResult(@NotNull
                       BuildResultsSummary buildResult)
Adds a BuildResultsSummary and sets the relationship to the ChainResultsSummary

Parameters:
buildResult -
Returns:
success

removeBuildResult

boolean removeBuildResult(@NotNull
                          BuildResultsSummary buildResult)
Removes a BuildResultsSummary

Parameters:
buildResult -
Returns:
success

isPending

boolean isPending()

isCompleted

boolean isCompleted()

isSuccessful

boolean isSuccessful()

isFailed

boolean isFailed()

isFinished

boolean isFinished()

getState

BuildState getState()

getLifeCycleState

LifeCycleState getLifeCycleState()


Copyright © 2011 Atlassian. All Rights Reserved.