com.atlassian.bamboo.project
Interface Project

All Superinterfaces:

BambooObject, Describable, DescriptionProvider, NameProvider

All Known Implementing Classes:

BuildObjectForTests, DefaultProject, TestBuildObjectForTests

public interface Project
extends BambooObject, Describable

Represents a Bamboo project object. Projects are top level entities and can have multiple Builds. A project can also have a default BuildDefinition that Builds extend.

Method Summary

java.util.List<Build>	getBuilds() Returns all Build associated with the Project.
java.util.List<Chain>	getChains() Returns all the Chain associated with the Project
java.lang.String	getCurrentStatus() Returns the string representatioin the current status of a build.
java.lang.String	getKey() Returns key of the project.
java.util.List<Labelling>	getLabellings()
java.lang.String	getName()
java.util.List<Plan>	getPlans() Returns all Plan associated with the Project.
java.util.List<Labelling>	getRelatedLabellings()
void	setKey(java.lang.String key) Sets the key for the project.
void	setLabellings(java.util.List<Labelling> labellings)
void	setName(java.lang.String name)

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

getId, setId

Methods inherited from interface com.atlassian.bamboo.Describable

setDescription

Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider

getDescription

Method Detail

getKey

@NotNull
java.lang.String getKey()

Returns key of the project. Keys are capital, alphanumeric strings.

Returns:

key of project. Must not be null.

getName

@NotNull
java.lang.String getName()

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

setName

void setName(@NotNull
             java.lang.String name)

Specified by:

setName in interface Describable

setKey

void setKey(@NotNull
            java.lang.String key)

Sets the key for the project. Must not be null

Parameters:

key -

getPlans

@NotNull
java.util.List<Plan> getPlans()

Returns all Plan associated with the Project. Returns Collections.EMPTY_LIST` if there are no Plans for the project.

Returns:

List of Plans. Collections.EMPTY_LIST` if no plans.

getBuilds

@NotNull
java.util.List<Build> getBuilds()

Returns all Build associated with the Project. Returns Collections.EMPTY_LIST` if there are no Builds for the project.

Returns:

List of Builds. Collections.EMPTY_LIST` if no builds.

getChains

@NotNull
java.util.List<Chain> getChains()

Returns all the Chain associated with the Project

Returns:

projects or empty collection if none found

getCurrentStatus

java.lang.String getCurrentStatus()

Returns the string representatioin the current status of a build. Mirrors Build@getCurrentStatus. It will return "current" if any plan is building, and "fail" if any plan is failing.

Returns:

a String

getLabellings

java.util.List<Labelling> getLabellings()

setLabellings

void setLabellings(java.util.List<Labelling> labellings)

getRelatedLabellings

java.util.List<Labelling> getRelatedLabellings()