com.atlassian.bamboo.project
Interface Project

All Superinterfaces:

BambooObject, Deletable, Describable, DescriptionProvider, NameProvider

All Known Implementing Classes:

BuildObjectForTests, DefaultProject, TestBuildObjectForTests

public interface Project
extends BambooObject, Describable, Deletable

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. Important: getPlans(), getTopLevelPlans()} are lazy loaded for performance reasons. If you need to guarantee that these collections are available use PlanManager.getPlansByProject(Project, Class)

Method Summary

java.lang.String	getCurrentStatus() Returns the string representation 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()
java.util.List<TopLevelPlan>	getTopLevelPlans() This methods returns all TopLevelPlans, including the ones marked for deletion This collection is a lazy relationship for performance reasons.
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.Describable

setDescription

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

getDescription

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

isMarkedForDeletion, setMarkedForDeletion

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

getId, setId

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.emptyList() if there are no Plans for the project. This collection is a lazy relationship for performance reasons. If you need to guarantee that these collections are available use PlanManager.getPlansByProject(Project, Class)

Returns:

List of Plans. Collections.emptyList() if no plans.

getTopLevelPlans

java.util.List<TopLevelPlan> getTopLevelPlans()

This methods returns all TopLevelPlans, including the ones marked for deletion This collection is a lazy relationship for performance reasons. If you need to guarantee that these collections are available use PlanManager.getPlansByProject(Project, Class) Use this method only if all you need is present in TopLevelPlan interface, otherwise consider using getAllChains.

Returns:

getCurrentStatus

java.lang.String getCurrentStatus()

Returns the string representation 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()