com.atlassian.bamboo.chains
Interface ChainStageResult

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

public interface ChainStageResult
extends BambooObject, Describable

Represents the result of a ChainStage execution

Since:
2.7

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()
           
 long getProcessingDuration()
          Processing duration of stage (time of longest job in stage execution)
 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 isManual()
          Checks if result as manual (at the time of result creation) Manual means stage execution is hold and waits for user interaction
 boolean isNotBuilt()
          Checks if the stage has unbuilt jobs inside it
 boolean isPending()
           
 boolean isRestartable()
          Checks if plan nas been failed and could be restarted on the stage where failed
 boolean isRunnable()
          Checks if current stage if first manual stage waiting for execution (chain is completed on previous stage and waiting for this stage to execute)
 boolean isSuccessful()
           
 boolean removeBuildResult(BuildResultsSummary buildResult)
          Removes a BuildResultsSummary
 void setChainResult(ChainResultsSummary chainResult)
          Sets the ChainResultsSummary associated with this Stage result
 void setManual(boolean manual)
          Marks result as optional (at the time of result creation) Manual means stage execution is hold and waits for user interaction
 void setProcessingDuration(long processingDuration)
           
 
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.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()

isManual

boolean isManual()
Checks if result as manual (at the time of result creation) Manual means stage execution is hold and waits for user interaction

Returns:
true if manual

setManual

void setManual(boolean manual)
Marks result as optional (at the time of result creation) Manual means stage execution is hold and waits for user interaction


isRunnable

boolean isRunnable()
Checks if current stage if first manual stage waiting for execution (chain is completed on previous stage and waiting for this stage to execute)

Returns:
true if stage is ready and allowed for manual execution

isRestartable

boolean isRestartable()
Checks if plan nas been failed and could be restarted on the stage where failed

Returns:

isNotBuilt

boolean isNotBuilt()
Checks if the stage has unbuilt jobs inside it

Returns:

getProcessingDuration

long getProcessingDuration()
Processing duration of stage (time of longest job in stage execution)

Returns:

setProcessingDuration

void setProcessingDuration(long processingDuration)
Parameters:
processingDuration -


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.