com.atlassian.bamboo.chains
Interface ChainStage

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

public interface ChainStage
extends Describable, BambooObject, Deletable


Method Summary
 boolean addJob(Job job)
          Adds a Job to the ChainStage
 java.util.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
 java.lang.String getDescription()
          Get the Stage Description
 java.util.Set<Job> getJobs()
          Gets the Jobs associated with this Stage, exlcuding the ones marked for deletion
 java.lang.String getName()
          Get the Stage Name
 boolean removeJob(Job job)
          Removes the Job from the ChainStage
 void setChain(Chain chain)
          Sets the Chain that the stage belongs to
 void setDescription(java.lang.String description)
          Set the Stage Description
 void setName(java.lang.String name)
          Set the Stage Name
 
Methods inherited from interface com.atlassian.bamboo.deletion.Deletable
isMarkedForDeletion, setMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.core.BambooObject
getId, setId
 

Method Detail

getName

@NotNull
java.lang.String getName()
Get the Stage Name

Specified by:
getName in interface DescriptionProvider
Specified by:
getName in interface NameProvider
Returns:
name

setName

void setName(@NotNull
             java.lang.String name)
Set the Stage Name

Specified by:
setName in interface Describable
Parameters:
name -

getDescription

@Nullable
java.lang.String getDescription()
Get the Stage Description

Specified by:
getDescription in interface DescriptionProvider
Returns:
description

setDescription

void setDescription(@NotNull
                    java.lang.String description)
Set the Stage Description

Specified by:
setDescription in interface Describable
Parameters:
description -

getChain

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

Returns:
chain

setChain

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

Parameters:
chain -

getJobs

@NotNull
java.util.Set<Job> getJobs()
Gets the Jobs associated with this Stage, exlcuding the ones marked for deletion

Returns:
jobs

getAllJobs

@NotNull
java.util.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 © 2011 Atlassian. All Rights Reserved.