com.atlassian.bamboo.project
Interface Project

All Superinterfaces:
BambooIdProvider, BambooObject, Deletable, Describable, DescriptionProvider, ImmutableDeletable, NameProvider, ProjectIdentifier
All Known Implementing Classes:
DefaultProject

public interface Project
extends BambooObject, 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. 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.util.List<Labelling> getLabellings()
           
 java.util.List<Plan> getPlans()
          Deprecated. since 3.2 PlanManager.getPlansByProject(Project, Class)
 java.util.List<Labelling> getRelatedLabellings()
           
 java.util.List<TopLevelPlan> getTopLevelPlans()
          Deprecated. since 3.2 PlanManager.getPlansByProject(Project, Class)
 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.deletion.Deletable
setMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.core.BambooObject
setId
 
Methods inherited from interface com.atlassian.bamboo.core.BambooIdProvider
getId
 
Methods inherited from interface com.atlassian.bamboo.plan.cache.ImmutableDeletable
isMarkedForDeletion
 
Methods inherited from interface com.atlassian.bamboo.Describable
setDescription
 
Methods inherited from interface com.atlassian.bamboo.project.ProjectIdentifier
getKey, getName
 
Methods inherited from interface com.atlassian.bamboo.utils.DescriptionProvider
getDescription
 

Method Detail

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
@Deprecated
java.util.List<Plan> getPlans()
Deprecated. since 3.2 PlanManager.getPlansByProject(Project, Class)

Returns all Plan associated with the Project. Returns Collections.emptyList() if there are no Plans for the project.

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

getTopLevelPlans

@Deprecated
java.util.List<TopLevelPlan> getTopLevelPlans()
Deprecated. since 3.2 PlanManager.getPlansByProject(Project, Class)

This methods returns all TopLevelPlans, including the ones marked for deletion 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 ImmutablePlan.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()


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.