ChainState (Atlassian Bamboo 6.10.6 API)

```
@Internal
public interface ChainState
```
In memory representation of the running Chain state

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`finishStopping()` Marks the `Chain` as finished stopping.
`long`	`getAverageDuration()` Average duration of the `Chain` in milliseconds
`BuildContext`	`getBuildContext()` The `BuildContext` of the currently executing chain
`com.atlassian.bamboo.chains.ChainBuildState`	`getChainBuildState(PlanResultKey planResultKey)` Gets the build state for the given buildResultKey
`Collection<com.atlassian.bamboo.chains.ChainBuildState>`	`getChainBuildStates()` Gets all the `ChainBuildState`s for the current `ChainState`
`StageState`	`getCurrentStage()` Gets the currently executing `StageState`
`int`	`getCurrentStageNumber()` Returns the cardinal number of currently executed stage.
`long`	`getElapsedTime()` Time taken to execute the `Chain` in milliseconds
`ExecutionContext`	`getExecutionContext()` Stores contextual data for the current `ChainState`
`MergeResultSummary`	`getMergeResult()`
`VcsWorkingCopy`	`getMergeWorkingCopy()`
`String`	`getName()` Get Chain name
`StageState`	`getNextStage()` Get the next stage
`PlanExecutionConfig.PlanExecutionType`	`getPlanExecutionType()` How this chain was executed, i.e.
`PlanResultKey`	`getPlanResultKey()` `PlanResultKey` for the the `Chain` execution
`StageState`	`getPreviousStage()` Gets the currently executing `StageState`
`Date`	`getQueueTime()` The queue `Date`
`List<StageState>`	`getStages()` Get all stages for Chain
`Date`	`getStartDate()` The start `Date`
`boolean`	`isCompleted()` Checks if the `Chain` has been completed
`boolean`	`isContinuable()` true if user will be able to manually continue the build after this execution ends
`boolean`	`isFailed()` Checks if the `Chain` has failed
`boolean`	`isGoingToStopAtManualStage()` true if the successfully finished chain is expected to stop at the (proceeding) manual stage
`boolean`	`isStopping()` Checks if the `Chain` is stopping
`boolean`	`isStopRequested()` Checks if the `Chain` has been requested to stop executing
`boolean`	`isSuccessful()` Checks if the `Chain` has successfully completed
`void`	`markAsStopping()` Marks the `Chain` as stopping
`StageState`	`proceedToNextStage(com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts, boolean lastExecutedStageSuccessful)` Replaces the current stage with the next stage in the queue and changes the reference to the current stage to the previous.
`void`	`setMergeResult(MergeResultSummary mergeResult)`
`void`	`setMergeWorkingCopy(VcsWorkingCopy workingCopy)`
`void`	`setStartDate(Date date)` The first call sets the start `Date`.
`void`	`updateVariableContext(VariableContext variableContext)`

- Method Detail
  - getName
```
@NotNull
String getName()
```
    Get Chain name
    
    Returns:
    
    name
  - getPlanResultKey
```
@NotNull
PlanResultKey getPlanResultKey()
```
    PlanResultKey for the the Chain execution
    
    Returns:
  - getStages
```
@NotNull
List<StageState> getStages()
```
    Get all stages for Chain
    
    Returns:
    
    stages
  - getChainBuildState
```
@Nullable
com.atlassian.bamboo.chains.ChainBuildState getChainBuildState(@NotNull
                                                                         PlanResultKey planResultKey)
```
    Gets the build state for the given buildResultKey
    
    Parameters:
    
    planResultKey -
    
    Returns:
    
    buildState
  - getChainBuildStates
```
@NotNull
Collection<com.atlassian.bamboo.chains.ChainBuildState> getChainBuildStates()
```
    Gets all the ChainBuildStates for the current ChainState
    
    Returns:
    
    buildStates
  - getPreviousStage
```
@Nullable
StageState getPreviousStage()
```
    Gets the currently executing StageState
    
    Returns:
    
    chainStageStage or null
  - getCurrentStage
```
@Nullable
StageState getCurrentStage()
```
    Gets the currently executing StageState
    
    Returns:
    
    chainStageStage or null
  - getCurrentStageNumber
```
int getCurrentStageNumber()
```
    Returns the cardinal number of currently executed stage.
    
    Returns:
    
    int
  - getNextStage
```
StageState getNextStage()
```
    Get the next stage
    
    Returns:
    
    stage
  - proceedToNextStage
```
StageState proceedToNextStage(@NotNull
                              com.google.common.collect.Multimap<String,Artifact> publishedChainArtifacts,
                              boolean lastExecutedStageSuccessful)
```
    Replaces the current stage with the next stage in the queue and changes the reference to the current stage to the previous.
    
    Returns:
    
    currentStage
  - isCompleted
```
boolean isCompleted()
```
    Checks if the Chain has been completed
    
    Returns:
    
    completed
  - isSuccessful
```
boolean isSuccessful()
```
    Checks if the Chain has successfully completed
    
    Returns:
    
    successful
  - isFailed
```
boolean isFailed()
```
    Checks if the Chain has failed
    
    Returns:
    
    failed
  - isStopping
```
boolean isStopping()
```
    Checks if the Chain is stopping
    
    Returns:
    
    stopping
  - isStopRequested
```
boolean isStopRequested()
```
    Checks if the Chain has been requested to stop executing
    
    Returns:
    
    stopRequested
  - markAsStopping
```
void markAsStopping()
```
    Marks the Chain as stopping
  - finishStopping
```
void finishStopping()
```
    Marks the Chain as finished stopping.
  - getBuildContext
```
@NotNull
BuildContext getBuildContext()
```
    The BuildContext of the currently executing chain
    
    Returns:
    
    buildContext
  - getExecutionContext
```
@NotNull
ExecutionContext getExecutionContext()
```
    Stores contextual data for the current ChainState
    
    Returns:
    
    executionContext
  - getAverageDuration
```
long getAverageDuration()
```
    Average duration of the Chain in milliseconds
    
    Returns:
    
    averageDuration
  - getStartDate
```
@Nullable
Date getStartDate()
```
    The start Date
    
    Returns:
    
    startDate
  - getQueueTime
```
@NotNull
Date getQueueTime()
```
    The queue Date
    
    Returns:
    
    queue time
  - setStartDate
```
void setStartDate(@NotNull
                  Date date)
```
    The first call sets the start Date. Subsequent calls have no effect.
    
    Parameters:
    
    date -
  - getElapsedTime
```
long getElapsedTime()
```
    Time taken to execute the Chain in milliseconds
    
    Returns:
    
    executionTime
  - getPlanExecutionType
```
@NotNull
PlanExecutionConfig.PlanExecutionType getPlanExecutionType()
```
    How this chain was executed, i.e. regularly, manually, etc.
    
    Returns:
    
    executionType
  - isGoingToStopAtManualStage
```
boolean isGoingToStopAtManualStage()
```
    true if the successfully finished chain is expected to stop at the (proceeding) manual stage
    
    Returns:
  - isContinuable
```
boolean isContinuable()
```
    true if user will be able to manually continue the build after this execution ends
  - getMergeResult
```
@Nullable
MergeResultSummary getMergeResult()
```
  - setMergeResult
```
void setMergeResult(@NotNull
                    MergeResultSummary mergeResult)
```
  - updateVariableContext
```
void updateVariableContext(@NotNull
                           VariableContext variableContext)
```
    Since:
    
    5.7
  - getMergeWorkingCopy
```
@Nullable
VcsWorkingCopy getMergeWorkingCopy()
```
    Since:
    
    5.14
  - setMergeWorkingCopy
```
void setMergeWorkingCopy(VcsWorkingCopy workingCopy)
```

Interface ChainState

Method Summary

Method Detail

getName

getPlanResultKey

getStages

getChainBuildState

getChainBuildStates

getPreviousStage

getCurrentStage

getCurrentStageNumber

getNextStage

proceedToNextStage

isCompleted

isSuccessful

isFailed

isStopping

isStopRequested

markAsStopping

finishStopping

getBuildContext

getExecutionContext

getAverageDuration

getStartDate

getQueueTime

setStartDate

getElapsedTime

getPlanExecutionType

isGoingToStopAtManualStage

isContinuable

getMergeResult

setMergeResult

updateVariableContext

getMergeWorkingCopy

setMergeWorkingCopy