com.atlassian.bamboo.chains
Interface ChainStage

All Superinterfaces:
BambooIdProvider, BambooObject, Deletable, Describable, DescriptionProvider, ImmutableChainStage, ImmutableDeletable, NameProvider
All Known Implementing Classes:
ChainStageImpl

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


Method Summary
 boolean addJob(Job job)
          Adds a Job to the ChainStage
 Collection<Job> getAllJobs()
          Gets the Jobs associated with this Stage, including the ones marked for deletion
 Chain getChain()
          Gets the Chain that the stage belongs to
 Set<Job> getJobs()
          Gets the Jobs associated with this Stage, exlcuding the ones marked for deletion
 boolean removeJob(Job job)
          Removes the Job from the ChainStage
 void setChain(Chain chain)
          Sets the Chain that the stage belongs to
 void setDescription(String description)
          Set the Stage Description
 void setManual(boolean manual)
           
 void setName(String name)
          Set the Stage Name
 
Methods inherited from interface com.atlassian.bamboo.chains.cache.ImmutableChainStage
getDescription, getMaster, getName, hasMaster, 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.core.BambooIdProvider
getId
 
Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable
isMarkedForDeletion
 

Method Detail

setName

void setName(@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)

getChain

@NotNull
Chain getChain()
Gets the Chain that the stage belongs to

Specified by:
getChain in interface ImmutableChainStage
Returns:
chain

setChain

void setChain(@NotNull
              Chain chain)
Sets the Chain that the stage belongs to

Parameters:
chain -

getJobs

@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
Collection<Job> getAllJobs()
Gets the Jobs associated with this Stage, including the ones marked for deletion

Returns:
jobs

addJob

boolean addJob(@NotNull
               Job job)
Adds a Job to the ChainStage

Parameters:
job -

removeJob

boolean removeJob(@NotNull
                  Job job)
Removes the Job from the ChainStage

Parameters:
job -


Copyright © 2015 Atlassian Software Systems Pty Ltd. All rights reserved.