Package com.atlassian.bamboo.project

Interface Project

All Superinterfaces:

BambooIdProvider, BambooObject, BambooObjectWithOid, Deletable, Describable, DescriptionProvider, EntityWithOid, ImmutableDeletable, ImmutableEntityWithOid, NameProvider, ProjectIdentifier

All Known Implementing Classes:

DefaultProject

public interface Project
extends BambooObjectWithOid, Deletable, Describable, ProjectIdentifier

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

Method Summary

Modifier and Type	Method	Description
String	getCurrentStatus()	Deprecated. since 8.2
default BambooEntityType	getEntityType()	Entity type of this object, used in BambooEntityOid.
List<Labelling>	getLabellings()
List<Labelling>	getRelatedLabellings()
@Nullable VcsBambooSpecsSource	getVcsBambooSpecsSource()
void	setKey(@NotNull String key)	Sets the key for the project.
void	setLabellings(List<Labelling> labellings)
void	setName(@NotNull String name)
void	setVcsBambooSpecsSource(VcsBambooSpecsSource vcsBambooSpecsSource)	Sets the specs source for the project.

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

setId

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

setMarkedForDeletion

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.core.EntityWithOid

setOid

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

isMarkedForDeletion

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

getOid

Methods inherited from interface com.atlassian.bamboo.project.ProjectIdentifier

getId, getKey, getName

Method Detail

setName

void setName(@NotNull
             @NotNull String name)

Specified by:

setName in interface Describable

setKey

void setKey(@NotNull
            @NotNull String key)

Sets the key for the project. Must not be null

Parameters:

key -

getCurrentStatus

@Deprecated
String getCurrentStatus()

Deprecated.

since 8.2

Returns the string representation the current status of a build. Mirrors ImmutablePlan.getCurrentStatus(). It will return "current" if any plan is building, and "fail" if any plan is failing.

Returns:

a String

getLabellings

List<Labelling> getLabellings()

setLabellings

void setLabellings(List<Labelling> labellings)

getRelatedLabellings

List<Labelling> getRelatedLabellings()

getVcsBambooSpecsSource

@Nullable
@Nullable VcsBambooSpecsSource getVcsBambooSpecsSource()

Returns:

specs source used to manage a project or null if the project is not managed by RSS

setVcsBambooSpecsSource

void setVcsBambooSpecsSource(VcsBambooSpecsSource vcsBambooSpecsSource)

Sets the specs source for the project.

Parameters:

vcsBambooSpecsSource - specs source

getEntityType

default BambooEntityType getEntityType()

Description copied from interface: ImmutableEntityWithOid

Entity type of this object, used in BambooEntityOid.

Specified by:

getEntityType in interface ImmutableEntityWithOid