com.atlassian.bamboo.chains
Interface StageExecution


public interface StageExecution

Represents a ChainStage executing within a Chain


Method Summary
 java.util.List<BuildExecution> getBuilds()
          Returns the BuildExecution's that are executed during this stage
 ChainExecution getChainExecution()
          Gets the ChainExecution that the StageExecution is a member of
 java.lang.String getDescription()
          Gets the description of the Stage
 ExecutionContext getExecutionContext()
          Stores contextual data for the current StageExecution
 java.lang.String getName()
          Gets the name of the Stage
 int getStageIndex()
          Index of the ChainStage within the current Chain
 boolean isBuilding()
          If the Stage is building or not
 boolean isCompleted()
          If the Stage has completed or not
 boolean isSuccessful()
          If the Stage is successful or not
 

Method Detail

getStageIndex

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

Returns:
0-based index of the stage

getChainExecution

@NotNull
ChainExecution getChainExecution()
Gets the ChainExecution that the StageExecution is a member of

Returns:
chainExecution

getName

@NotNull
java.lang.String getName()
Gets the name of the Stage

Returns:
name

getDescription

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

Returns:
description

isBuilding

boolean isBuilding()
If the Stage is building or not

Returns:
building

isCompleted

boolean isCompleted()
If the Stage has completed or not

Returns:
completed

isSuccessful

boolean isSuccessful()
If the Stage is successful or not

Returns:
successful

getBuilds

@NotNull
java.util.List<BuildExecution> getBuilds()
Returns the BuildExecution's that are executed during this stage

Returns:
builds

getExecutionContext

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

Returns:
executionContext


Copyright © 2012 Atlassian. All Rights Reserved.