Package com.atlassian.bamboo.plugins.rest.service

Interface ProjectsRestService

All Known Implementing Classes:

ProjectsRestServiceImpl

public interface ProjectsRestService

Method Summary

Modifier and Type	Method	Description
void	assertBuildProjectExists(String projectKey)
Project	getBuildProjectByKey(String projectKey)
List<Project>	getBuildProjects(@NotNull javax.ws.rs.core.UriInfo uriInfo)	Get a list of build projects.
List<DeploymentProject>	getDeploymentProjects(@NotNull javax.ws.rs.core.UriInfo uriInfo)	Get a list of deployment projects.

Method Detail

assertBuildProjectExists

void assertBuildProjectExists(String projectKey)
                       throws NotFoundException

Throws:

NotFoundException

getBuildProjectByKey

Project getBuildProjectByKey(String projectKey)
                      throws NotFoundException

Throws:

NotFoundException

getBuildProjects

List<Project> getBuildProjects(@NotNull
                               @NotNull javax.ws.rs.core.UriInfo uriInfo)

Get a list of build projects. This method provides filtering using the following query params:

searchTerm

if specified return only projects, which name contains specified term

permission

if specified return only projects that user has this specific permission for

Parameters:

uriInfo -

Returns:

Filtered list of build projects.

getDeploymentProjects

List<DeploymentProject> getDeploymentProjects(@NotNull
                                              @NotNull javax.ws.rs.core.UriInfo uriInfo)

Get a list of deployment projects. This method provides filtering using the following query params:

searchTerm

if specified return only projects, which name contains specified term

permission

if specified return only plans that user has this specific permission for

Parameters:

uriInfo -

Returns:

Filtered list of deployment projects.