com.atlassian.bamboo.project

Interface ProjectManager

All Known Implementing Classes:

DefaultProjectManager

public interface ProjectManager

Manager for Project

Method Summary

Modifier and Type	Method and Description
Project	createAndSaveProject(String key, String name, String description, boolean grantAllUsersAccess) Create new project and store it.
default Project	createProject(String key, String name) Creates a new Project Note that this method will not save the project
Project	createProject(String key, String name, String description) Creates a new Project
void	deleteProject(Project project) Removes the project from the system
Set<Project>	getAllProjects() Returns a collection of Project objects
Collection<Project>	getAllProjectsMarkedForDeletion()
List<Project>	getEmptyProjects() Returns empty projects.
Number	getNonDeletedProjectCount() Returns the number of projects, excluding the ones marked for deletion.
List<Project>	getNonEmptyProjects() Returns non empty projects.
Project	getProjectById(long id) Returns the project given the id
Project	getProjectByKey(String key) Returns the project given a project key
Project	getProjectByName(String projectName) Returns project by name
Project	getProjectByOid(BambooEntityOid oid) Returns project by oid
Number	getProjectCount() Returns the number of projects, including the ones marked for deletion.
Set<Project>	getProjects() Returns a collection of Project objects
List<Project>	getSortedProjects() Returns a sorted by name list of projects.
boolean	isExistingProjectKey(String projectKey) Returns true if the project name already exists
boolean	isExistingProjectName(String projectName) Returns true if the project name already exists
void	saveProject(Project project) Saves the project.

Method Detail

createProject

@NotNull
default Project createProject(@NotNull
                                       String key,
                                       @NotNull
                                       String name)

Creates a new Project Note that this method will not save the project

Parameters:

key - project key

name - project name

Returns:

project

createProject

@NotNull
Project createProject(@NotNull
                               String key,
                               @NotNull
                               String name,
                               @NotNull
                               String description)

Creates a new Project

Parameters:

key - project key

name - project name

description - project description

Returns:

project

createAndSaveProject

Project createAndSaveProject(@NotNull
                             String key,
                             @NotNull
                             String name,
                             @Nullable
                             String description,
                             boolean grantAllUsersAccess)

Create new project and store it.

Parameters:

key - project key

name - project name

description - project description

grantAllUsersAccess - if anonymous and logged-in users should have READ permission for new project

Returns:

project

getProjects

@NotNull
Set<Project> getProjects()

Returns a collection of Project objects

Returns:

all Projects in the system, excluding the ones marked for deletion

getNonEmptyProjects

@NotNull
List<Project> getNonEmptyProjects()

Returns non empty projects.

Returns:

projects not marked for deletion with top level plans

getEmptyProjects

@NotNull
List<Project> getEmptyProjects()

Returns empty projects.

Returns:

projects not marked for deletion without top level plans

getSortedProjects

@NotNull
List<Project> getSortedProjects()

Returns a sorted by name list of projects.

getAllProjects

@NotNull
Set<Project> getAllProjects()

Returns a collection of Project objects

Returns:

all Projects in the system, including the ones marked for deletion

getProjectCount

Number getProjectCount()

Returns the number of projects, including the ones marked for deletion.

getNonDeletedProjectCount

Number getNonDeletedProjectCount()

Returns the number of projects, excluding the ones marked for deletion.

getProjectByKey

@Nullable
Project getProjectByKey(@NotNull
                                  String key)

Returns the project given a project key

Parameters:

key - - the project key e.g. BAMBOO (not BAMBOO-TRUNK)

Returns:

A Project if the key matches. Otherwise null

getProjectById

@Nullable
Project getProjectById(long id)

Returns the project given the id

Parameters:

id - project id

Returns:

A Project. null if not found.

getProjectByOid

@Nullable
Project getProjectByOid(@NotNull
                                  BambooEntityOid oid)

Returns project by oid

Since:

5.15

getProjectByName

Project getProjectByName(@NotNull
                         String projectName)

Returns project by name

Parameters:

projectName -

Returns:

project

isExistingProjectKey

boolean isExistingProjectKey(@NotNull
                             String projectKey)

Returns true if the project name already exists

Parameters:

projectKey - to check

Returns:

true if projectName already exists

isExistingProjectName

boolean isExistingProjectName(@NotNull
                              String projectName)

Returns true if the project name already exists

Parameters:

projectName - to check

Returns:

true if projectName already exists

saveProject

void saveProject(@NotNull
                 Project project)

Saves the project. For new project it creates required ACL records.

Parameters:

project - to be saved

deleteProject

void deleteProject(@NotNull
                   Project project)

Removes the project from the system

Parameters:

project - project

getAllProjectsMarkedForDeletion

@NotNull
Collection<Project> getAllProjectsMarkedForDeletion()

Returns:

all Projects that are marked for deletion..