com.atlassian.bamboo.deployments.projects
Interface InternalDeploymentProject

All Superinterfaces:

BambooIdProvider, DescriptionProvider, NameProvider

All Known Subinterfaces:

DeploymentProject, MutableDeploymentProject

All Known Implementing Classes:

DeploymentProjectIdentifier, DeploymentProjectImpl, MutableDeploymentProjectImpl

public interface InternalDeploymentProject
extends BambooIdProvider, NameProvider, DescriptionProvider

Common interface between all types of Deployment Projects. Defines relationship between client side objects and db objects. Though probably not useful for anything else. Be wary when adding things to this interface - be sure it makes sense in all contexts.

Method Summary

java.lang.String	getDescription()
long	getId()
DeploymentKey	getKey()
java.lang.String	getName()
PlanKey	getPlanKey() Not really used by anything except UI

Method Detail

getId

long getId()

Specified by:

getId in interface BambooIdProvider

Returns:

unique identifier (in this case from database)

getKey

@NotNull
DeploymentKey getKey()

getName

@NotNull
java.lang.String getName()

Specified by:

getName in interface DescriptionProvider

Specified by:

getName in interface NameProvider

Returns:

User friendly shortish name for this deployment project. Must be unique with in Bamboo

getDescription

@Nullable
java.lang.String getDescription()

Specified by:

getDescription in interface DescriptionProvider

Returns:

Optional, longer description of the project

getPlanKey

@Nullable
PlanKey getPlanKey()

Not really used by anything except UI

Returns:

the plan key of the linked plan to this deployment Project.