com.atlassian.bamboo.chains
Interface ChainExecution


public interface ChainExecution

Represents an executing Chain


Method Summary
 BuildIdentifier getBuildIdentifier()
          Returns the BuildIdentifier associated with this ChainExecution
 int getChainNumber()
          Get the Chain result number
 java.lang.String getChainResultKey()
          Get the Chain result full key - chain key and chain number - "KEY-NUMBER"
 ExecutionContext getExecutionContext()
          Stores contextual data for the current ChainExecution
 java.lang.String getKey()
          Gets the key of the executing Chain
 java.lang.String getName()
          Gets the name of the executing Chain
 java.util.List<StageExecution> getStages()
          Get Stages for this Chain
 boolean isCompleted()
          Returns true if the chain has finished executing
 boolean isSuccessful()
          Returns true if the chain has finished executing successfuly
 

Method Detail

getName

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

Returns:
name

getKey

@NotNull
java.lang.String getKey()
Gets the key of the executing Chain

Returns:

getChainNumber

int getChainNumber()
Get the Chain result number

Returns:
number

getChainResultKey

@NotNull
java.lang.String getChainResultKey()
Get the Chain result full key - chain key and chain number - "KEY-NUMBER"

Returns:

getStages

@NotNull
java.util.List<StageExecution> getStages()
Get Stages for this Chain

Returns:
stages

isCompleted

boolean isCompleted()
Returns true if the chain has finished executing

Returns:
false

isSuccessful

boolean isSuccessful()
Returns true if the chain has finished executing successfuly

Returns:
success

getBuildIdentifier

@NotNull
BuildIdentifier getBuildIdentifier()
Returns the BuildIdentifier associated with this ChainExecution

Returns:

getExecutionContext

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

Returns:
exectionContext


Copyright © 2010 Atlassian. All Rights Reserved.