com.atlassian.bamboo.chains
Interface StageState


public interface StageState


Method Summary
 com.atlassian.bamboo.chains.ChainBuildState get(PlanResultKey planResultKey)
          Gets the Build State given the build result key
 java.util.Collection<com.atlassian.bamboo.chains.ChainBuildState> getBuilds()
          Get Builds associated with this Stage
 java.lang.Long getChainStageResultId()
          The id of the ChainStageResult
 java.lang.String getDescription()
          Get the Stage description
 ExecutionContext getExecutionContext()
          Stores contextual data for the current StageState
 java.lang.String getName()
          Get Stage name
 int getStageIndex()
          Index of the ChainStage within the current Chain
 boolean isBuilding()
          Checks if the stage is building
 boolean isCompleted()
          Checks if the stage has been marked as completed
 boolean isFailed()
          Checks if the stage has failed
 boolean isManual()
           
 boolean isSuccessful()
          Checks if the stage has completed successfully
 boolean isWaiting()
          Checks if the stage is waiting to be executed
 

Method Detail

getChainStageResultId

java.lang.Long getChainStageResultId()
The id of the ChainStageResult

Returns:
id

getStageIndex

int getStageIndex()
Index of the ChainStage within the current Chain

Returns:
0-based index of the stage

getName

@NotNull
java.lang.String getName()
Get Stage name

Returns:
name

getDescription

@Nullable
java.lang.String getDescription()
Get the Stage description

Returns:
description

getBuilds

@NotNull
java.util.Collection<com.atlassian.bamboo.chains.ChainBuildState> getBuilds()
Get Builds associated with this Stage

Returns:
builds

isWaiting

boolean isWaiting()
Checks if the stage is waiting to be executed

Returns:
waiting

isBuilding

boolean isBuilding()
Checks if the stage is building

Returns:
building

isCompleted

boolean isCompleted()
Checks if the stage has been marked as completed

Returns:
completed

isSuccessful

boolean isSuccessful()
Checks if the stage has completed successfully

Returns:
success

isFailed

boolean isFailed()
Checks if the stage has failed

Returns:
failure

get

@Nullable
com.atlassian.bamboo.chains.ChainBuildState get(@NotNull
                                                         PlanResultKey planResultKey)
Gets the Build State given the build result key

Parameters:
planResultKey -
Returns:
buildState

getExecutionContext

@NotNull
ExecutionContext getExecutionContext()
Stores contextual data for the current StageState

Returns:
executionContext

isManual

boolean isManual()


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