com.atlassian.bamboo.chains

Interface ChainStage

All Superinterfaces:

BambooIdProvider, BambooObject, Deletable, Describable, DescriptionProvider, EntityWithOid, ImmutableChainStage, ImmutableDeletable, ImmutableEntityWithOid, NameProvider

All Known Implementing Classes:

ChainStageImpl

@PublicApi
public interface ChainStage
extends ImmutableChainStage, Describable, BambooObject, Deletable, EntityWithOid

Method Summary

Modifier and Type	Method and Description
boolean	addJob(@NotNull Job job) Adds a Job to the ChainStage
@NotNull Collection<Job>	getAllJobs() Gets the Jobs associated with this Stage, including the ones marked for deletion
@NotNull Chain	getChain() Gets the Chain that the stage belongs to
@NotNull Set<Job>	getJobs() Gets the Jobs associated with this Stage, exlcuding the ones marked for deletion
boolean	removeJob(@NotNull Job job) Removes the Job from the ChainStage
void	setChain(@NotNull Chain chain) Sets the Chain that the stage belongs to
void	setDescription(String description) Set the Stage Description
void	setFinal(boolean finalStage)
void	setManual(boolean manual)
void	setName(@NotNull String name) Set the Stage Name

Methods inherited from interface com.atlassian.bamboo.chains.cache.ImmutableChainStage

getDatabaseId, getDescription, getEntityType, getId, getMaster, getName, hasMaster, isFinal, isManual

Methods inherited from interface com.atlassian.bamboo.deletion.Deletable

setMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.core.BambooObject

setId

Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable

isMarkedForDeletion

Methods inherited from interface com.atlassian.bamboo.core.EntityWithOid

setOid

Methods inherited from interface com.atlassian.bamboo.core.ImmutableEntityWithOid

getOid

Method Detail

setName

void setName(@NotNull
             @NotNull String name)

Set the Stage Name

Specified by:

setName in interface Describable

Parameters:

name -

setDescription

void setDescription(String description)

Set the Stage Description

Specified by:

setDescription in interface Describable

Parameters:

description -

setManual

void setManual(boolean manual)

setFinal

void setFinal(boolean finalStage)

getChain

@NotNull
@NotNull Chain getChain()

Gets the Chain that the stage belongs to

Specified by:

getChain in interface ImmutableChainStage

Returns:

chain

setChain

void setChain(@NotNull
              @NotNull Chain chain)

Sets the Chain that the stage belongs to

Parameters:

chain -

getJobs

@NotNull
@NotNull Set<Job> getJobs()

Gets the Jobs associated with this Stage, exlcuding the ones marked for deletion

Specified by:

getJobs in interface ImmutableChainStage

Returns:

jobs

getAllJobs

@NotNull
@NotNull Collection<Job> getAllJobs()

Gets the Jobs associated with this Stage, including the ones marked for deletion

Returns:

jobs

addJob

boolean addJob(@NotNull
               @NotNull Job job)

Adds a Job to the ChainStage

Parameters:

job -

removeJob

boolean removeJob(@NotNull
                  @NotNull Job job)

Removes the Job from the ChainStage

Parameters:

job -