jetbrains.buildServer
Interface BuildProject

All Superinterfaces:
java.lang.Comparable<BuildProject>
All Known Subinterfaces:
SProject

public interface BuildProject
extends java.lang.Comparable<BuildProject>

This interface provides information about TeamCity project


Field Summary
static java.lang.String ROOT_PROJECT_ID
          The internal and external identifier of the root project.
 
Method Summary
 java.util.List<? extends BuildType> getBuildTypes()
          Returns all build configurations registered in this project and all its subprojects (not only direct).
 java.lang.String getDescription()
          Returns project description
 java.lang.String getExternalId()
          Returns the external project identifier.
 java.lang.String getFullName()
          Returns project full name in the form: <parent project name> :: <parent project name> :: ...
 java.lang.String getName()
          Returns project name
 java.util.List<? extends BuildType> getOwnBuildTypes()
          Returns all build configurations registered in this certain project.
 java.util.List<? extends BuildProject> getOwnProjects()
          Returns direct child projects of this project.
 java.util.List<? extends VcsRoot> getOwnVcsRoots()
          Returns all VCS roots used by build configurations or templates in this certain project.
 BuildProject getParentProject()
          Returns the parent project of this project.
 java.lang.String getParentProjectExternalId()
          Returns external id of the parent project of this project.
 java.lang.String getParentProjectId()
          Returns internal id of the parent project of this project.
 java.lang.String getProjectId()
          Returns the internal project identifier.
 java.util.List<? extends BuildProject> getProjects()
          Returns all child projects (including children of children and so on) of this project.
 Status getStatus()
          Returns project status calculated according to cumulative status of all build configurations registered in the project.
 java.util.List<? extends VcsRoot> getVcsRoots()
          Returns all VCS roots used by build configurations or templates in this project and all its subprojects (not only direct).
 boolean isRootProject()
          Returns true iff this project is root project
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Field Detail

ROOT_PROJECT_ID

@NotNull
static final java.lang.String ROOT_PROJECT_ID
The internal and external identifier of the root project.

Since:
8.0
See Also:
getProjectId(), getExternalId()
Method Detail

getProjectId

@NotNull
java.lang.String getProjectId()
Returns the internal project identifier.

Before 8.0 TC there was only one project identifier. Since 8.0 there are two project identifiers: internal (with a surrogate value, to use in DB) and external (that is build based on the project name, or specified by users).

Returns:
internal id.
See Also:
getExternalId()

getExternalId

@NotNull
java.lang.String getExternalId()
Returns the external project identifier.

Returns:
external identifier.
Since:
8.0
See Also:
getProjectId()

getParentProject

@Nullable
BuildProject getParentProject()
Returns the parent project of this project.

Every project, except the root one, has a parent project.

Returns:
parent project or null if it is the root project
Since:
8.0
See Also:
getParentProjectId(), getParentProjectExternalId()

getParentProjectId

@Nullable
java.lang.String getParentProjectId()
Returns internal id of the parent project of this project.

Every project, except the root one, has a parent project.

Returns:
parent project internal id or null if it is the root project
Since:
8.0
See Also:
getParentProject(), getParentProjectExternalId()

getParentProjectExternalId

@Nullable
java.lang.String getParentProjectExternalId()
Returns external id of the parent project of this project.

Every project, except the root one, has a parent project.

Returns:
parent project external id or null if it is the root project
Since:
8.0
See Also:
getParentProject(), getParentProjectId()

isRootProject

boolean isRootProject()
Returns true iff this project is root project

Returns:
see above
Since:
8.0

getOwnProjects

@NotNull
java.util.List<? extends BuildProject> getOwnProjects()
Returns direct child projects of this project.

Returns:
list of projects sorted by name
Since:
8.0

getProjects

@NotNull
java.util.List<? extends BuildProject> getProjects()
Returns all child projects (including children of children and so on) of this project.

Returns:
list of projects sorted by name
Since:
8.0

getName

@NotNull
java.lang.String getName()
Returns project name

Returns:
presentable name

getFullName

@NotNull
java.lang.String getFullName()
Returns project full name in the form: <parent project name> :: <parent project name> :: ... :: <project name>. Root project name is not included in this sequence, so the first name in the sequence is the name of some child of the root project.

Returns:
presentable name
Since:
8.0

getDescription

@NotNull
java.lang.String getDescription()
Returns project description

Returns:
project description

getStatus

Status getStatus()
Returns project status calculated according to cumulative status of all build configurations registered in the project.

Returns:
current project status

getOwnBuildTypes

@NotNull
java.util.List<? extends BuildType> getOwnBuildTypes()
Returns all build configurations registered in this certain project. Does NOT include build configurations from subprojects.

Returns:
list of build configurations sorted by name

getBuildTypes

@NotNull
java.util.List<? extends BuildType> getBuildTypes()
Returns all build configurations registered in this project and all its subprojects (not only direct).

Returns:
list of build configurations sorted by name
Since:
8.0

getOwnVcsRoots

@NotNull
java.util.List<? extends VcsRoot> getOwnVcsRoots()
Returns all VCS roots used by build configurations or templates in this certain project. Does NOT include VCS roots used by build configurations or templates in subprojects.

Returns:
list of VCS roots

getVcsRoots

@NotNull
java.util.List<? extends VcsRoot> getVcsRoots()
Returns all VCS roots used by build configurations or templates in this project and all its subprojects (not only direct).

Returns:
list of vcs roots
Since:
8.0