com.atlassian.bamboo.chains
Interface ChainManager

All Known Implementing Classes:

ChainManagerImpl

public interface ChainManager

Management of Chain's

Method Summary

Chain	create(Project project, java.lang.String chainKey, java.lang.String name, java.lang.String description) Creates a new Chain
boolean	exists(java.lang.String fullKey) Checks if the Chain exists using the full key (eg BAM-BOO)
java.util.Collection<Chain>	getAllChains() Returns all the Chain's
Chain	getByChainKey(java.lang.String key) Gets the Chain by its key (eg.
Chain	getByPlanKey(PlanKey planKey) Gets the Chain by its PlanKey
int	getNextChainNumber(Chain chain) Get Next Chain Number
boolean	isExistingKey(Project project, java.lang.String key) Checks if the Chain exists by its key
boolean	isExistingName(Project project, java.lang.String name) Checks if the Chain exists by its name
void	moveStage(Chain chain, int newPosition, ChainStage chainStage) Move a ChainStage to a new position
void	save(Chain chain) Saves the Chain

Method Detail

getByPlanKey

@Nullable
Chain getByPlanKey(@NotNull
                            PlanKey planKey)

Gets the Chain by its PlanKey

Parameters:

planKey -

Returns:

chain

getByChainKey

@Nullable
Chain getByChainKey(@NotNull
                             java.lang.String key)

Gets the Chain by its key (eg. BAM-FOO)

Parameters:

key -

Returns:

chain

getAllChains

@NotNull
java.util.Collection<Chain> getAllChains()

Returns all the Chain's

Returns:

chain

create

@NotNull
Chain create(@NotNull
                     Project project,
                     @NotNull
                     java.lang.String chainKey,
                     @NotNull
                     java.lang.String name,
                     java.lang.String description)

Creates a new Chain

Parameters:

project -

chainKey -

name -

description -

Returns:

chain

save

void save(@NotNull
          Chain chain)

Saves the Chain

Parameters:

chain -

exists

boolean exists(@NotNull
               java.lang.String fullKey)

Checks if the Chain exists using the full key (eg BAM-BOO)

Parameters:

fullKey -

Returns:

exists

isExistingKey

boolean isExistingKey(@NotNull
                      Project project,
                      @NotNull
                      java.lang.String key)

Checks if the Chain exists by its key

Parameters:

project -

key -

Returns:

exists

isExistingName

boolean isExistingName(@NotNull
                       Project project,
                       @NotNull
                       java.lang.String name)

Checks if the Chain exists by its name

Parameters:

name -

Returns:

exists

getNextChainNumber

int getNextChainNumber(@NotNull
                       Chain chain)

Get Next Chain Number

Parameters:

chain -

Returns:

number

moveStage

void moveStage(@NotNull
               Chain chain,
               int newPosition,
               @NotNull
               ChainStage chainStage)

Move a ChainStage to a new position

Parameters:

newPosition -

chain -

chainStage -