com.atlassian.crucible.spi.services

Interface ProjectService

public interface ProjectService

Provides an API for working with Projects

Since:

3.5

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROJECT_KEY_PATTERN

Method Summary

Modifier and Type	Method and Description
boolean	addProjectAllowedReviewerGroup(java.lang.String projectKey, java.lang.String groupName) Adds group to list of project allowed reviewer groups
boolean	addProjectAllowedReviewerUser(java.lang.String projectKey, java.lang.String username) Adds user to list of project allowed reviewer users
boolean	addProjectDefaultReviewerGroup(java.lang.String projectKey, java.lang.String groupName) Adds group to list of project default reviewer groups
boolean	addProjectDefaultReviewerUser(java.lang.String projectKey, java.lang.String username) Adds user to list of project default reviewer users
int	countProjects(ProjectSearchCriteria projectSearchCriteria) Returns the number of projects filtered by project search criteria
void	create(ProjectData projectData) Creates a new project
void	delete(java.lang.String projectKey) Deletes project with given key Will fail if project contains reviews.
void	delete(java.lang.String projectKey, boolean deleteReviewsInProject) Deletes project with given key including reviews if deleteProjectReviews is true.
boolean	deleteProjectAllowedReviewerGroup(java.lang.String projectKey, java.lang.String groupName) Deletes group from list of project allowed reviewer groups
boolean	deleteProjectAllowedReviewerUser(java.lang.String projectKey, java.lang.String username) Deletes user from list of project allowed reviewer users
boolean	deleteProjectDefaultReviewerGroup(java.lang.String projectKey, java.lang.String groupName) Deletes group from list of project default reviewer groups
boolean	deleteProjectDefaultReviewerUser(java.lang.String projectKey, java.lang.String username) Deletes user from list of project default reviewer users
boolean	exist(java.lang.String projectKey) Checks it project with given key exists.
java.util.List<ProjectData>	getAllProjects() Returns the details of all Crucible projects that the caller is entitled to access.
java.util.List<ProjectData>	getAllProjects(boolean excludeAllowedReviewers) Returns the details of all Crucible projects that the caller is entitled to access, optionally loading all user data.
ProjectData	getProject(java.lang.Integer id) Deprecated.
ProjectData	getProject(java.lang.String projectKey) Get a project from its key -- this does not load the list of allowed reviewers
ProjectData	getProject(java.lang.String projectKey, boolean excludeAllowedReviewers) Get the details of a project, optionally including the list of allowed reviewers, which is expensive to get.
Page<java.lang.String>	getProjectAllowedReviewerGroups(java.lang.String projectKey, PageRequest pageRequest) Get paged list of project allowed users
java.lang.Iterable<java.lang.String>	getProjectAllowedReviewerGroupsIterable(java.lang.String projectKey, PageRequest pageRequest) Returns a service-object as an Iterable used to iterate over project allowed reviewer groups Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved.
Page<java.lang.String>	getProjectAllowedReviewerUsers(java.lang.String projectKey, PageRequest pageRequest) Get paged list of project default allowed users
java.lang.Iterable<java.lang.String>	getProjectAllowedReviewerUsersIterable(java.lang.String projectKey, PageRequest firstPageRequest) Returns a service-object as an Iterable used to iterate over project allowed reviewer users Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved.
Page<java.lang.String>	getProjectDefaultReviewerGroups(java.lang.String projectKey, PageRequest pageRequest) Get a paged list of project default reviewer groups
java.lang.Iterable<java.lang.String>	getProjectDefaultReviewerGroupsIterable(java.lang.String projectKey, PageRequest firstPageRequest) Returns a service-object as an Iterable used to iterate over project default reviewer groups Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved.
Page<java.lang.String>	getProjectDefaultReviewerUsers(java.lang.String projectKey, PageRequest pageRequest) Get paged list of project default reviewer users
java.lang.Iterable<java.lang.String>	getProjectDefaultReviewerUsersIterable(java.lang.String projectKey, PageRequest firstPageRequest) Returns a service-object as an Iterable used to iterate over project default reviewer users Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved.
java.lang.Integer	getProjectId(java.lang.String projectKey) Get project ID from its key
boolean	hasPermission(java.lang.String projectKey, java.lang.String actionName) Does the current user have this permission at a project level?
void	moveAllReviews(java.lang.String sourceProjectKey, java.lang.String destinationProjectKey) Moves all reviews and snippets from project with sourceProjectKey to project with destinationProjectKey
Page<ProjectData>	searchProjects(ProjectSearchCriteria projectSearchCriteria, PageRequest pageRequest) Returns a page of projects filtered by project search criteria
java.lang.Iterable<ProjectData>	searchProjectsIterable(ProjectSearchCriteria projectSearchCriteria, PageRequest firstPageRequest) Returns a service-object as an Iterable used to iterate over projects Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved.
void	update(ProjectData projectData) Updates an existing project

Field Detail

PROJECT_KEY_PATTERN

static final java.lang.String PROJECT_KEY_PATTERN

See Also:

Constant Field Values

Method Detail

getAllProjects

java.util.List<ProjectData> getAllProjects()

Returns the details of all Crucible projects that the caller is entitled to access. The ProjectData instances do not contain the allowed reviewers lists.

countProjects

int countProjects(ProjectSearchCriteria projectSearchCriteria)

Returns the number of projects filtered by project search criteria

Returns:

number of projects

searchProjects

Page<ProjectData> searchProjects(ProjectSearchCriteria projectSearchCriteria,
                                 PageRequest pageRequest)

Returns a page of projects filtered by project search criteria

Returns:

page of projectData

searchProjectsIterable

java.lang.Iterable<ProjectData> searchProjectsIterable(ProjectSearchCriteria projectSearchCriteria,
                                                       PageRequest firstPageRequest)

Returns a service-object as an Iterable used to iterate over projects Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved. firstPageRequest is used to get the first page, following page requests will be created from Page.getNextPageRequest()

create

void create(ProjectData projectData)

Creates a new project

update

void update(ProjectData projectData)

Updates an existing project

delete

void delete(java.lang.String projectKey)

Deletes project with given key Will fail if project contains reviews.

delete

void delete(java.lang.String projectKey,
            boolean deleteReviewsInProject)

Deletes project with given key including reviews if deleteProjectReviews is true.

Parameters:

deleteReviewsInProject - if true deletes reviews

getAllProjects

java.util.List<ProjectData> getAllProjects(boolean excludeAllowedReviewers)

Returns the details of all Crucible projects that the caller is entitled to access, optionally loading all user data.

Parameters:

excludeAllowedReviewers - if set to true, the allowedReviewers List<String> on each ProjectData will be null. Setting this to false can be very expensive especially if you have many projects and are using an external authentication service such as Crowd or Jira.

getProjectId

java.lang.Integer getProjectId(java.lang.String projectKey)

Get project ID from its key

Returns:

project ID if project with given key exist or null if not found

getProject

ProjectData getProject(java.lang.String projectKey)

Get a project from its key -- this does not load the list of allowed reviewers

Returns:

projectData if project with given key exist or null if not found

getProject

ProjectData getProject(java.lang.String projectKey,
                       boolean excludeAllowedReviewers)

Get the details of a project, optionally including the list of allowed reviewers, which is expensive to get.

Returns:

projectData if project with given key exist or null if not found

getProjectDefaultReviewerUsers

Page<java.lang.String> getProjectDefaultReviewerUsers(java.lang.String projectKey,
                                                      PageRequest pageRequest)

Get paged list of project default reviewer users

Returns:

Page of user names

getProjectDefaultReviewerUsersIterable

java.lang.Iterable<java.lang.String> getProjectDefaultReviewerUsersIterable(java.lang.String projectKey,
                                                                            PageRequest firstPageRequest)

Returns a service-object as an Iterable used to iterate over project default reviewer users Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved. firstPageRequest is used to get the first page, following page requests will be created from Page.getNextPageRequest()

addProjectDefaultReviewerUser

boolean addProjectDefaultReviewerUser(java.lang.String projectKey,
                                      java.lang.String username)

Adds user to list of project default reviewer users

Returns:

true if added or false if user was already in the list

deleteProjectDefaultReviewerUser

boolean deleteProjectDefaultReviewerUser(java.lang.String projectKey,
                                         java.lang.String username)

Deletes user from list of project default reviewer users

Returns:

true if deleted or false if user was not in list

getProjectDefaultReviewerGroups

Page<java.lang.String> getProjectDefaultReviewerGroups(java.lang.String projectKey,
                                                       PageRequest pageRequest)

Get a paged list of project default reviewer groups

Returns:

Page of group names

getProjectDefaultReviewerGroupsIterable

java.lang.Iterable<java.lang.String> getProjectDefaultReviewerGroupsIterable(java.lang.String projectKey,
                                                                             PageRequest firstPageRequest)

Returns a service-object as an Iterable used to iterate over project default reviewer groups Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved. firstPageRequest is used to get the first page, following page requests will be created from Page.getNextPageRequest()

addProjectDefaultReviewerGroup

boolean addProjectDefaultReviewerGroup(java.lang.String projectKey,
                                       java.lang.String groupName)

Adds group to list of project default reviewer groups

Returns:

true if added or false if user was already in the list

deleteProjectDefaultReviewerGroup

boolean deleteProjectDefaultReviewerGroup(java.lang.String projectKey,
                                          java.lang.String groupName)

Deletes group from list of project default reviewer groups

Returns:

true if deleted or false if user was not in list

getProjectAllowedReviewerUsers

Page<java.lang.String> getProjectAllowedReviewerUsers(java.lang.String projectKey,
                                                      PageRequest pageRequest)

Get paged list of project default allowed users

Returns:

Page of user names

getProjectAllowedReviewerUsersIterable

java.lang.Iterable<java.lang.String> getProjectAllowedReviewerUsersIterable(java.lang.String projectKey,
                                                                            PageRequest firstPageRequest)

Returns a service-object as an Iterable used to iterate over project allowed reviewer users Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved. firstPageRequest is used to get the first page, following page requests will be created from Page.getNextPageRequest()

addProjectAllowedReviewerUser

boolean addProjectAllowedReviewerUser(java.lang.String projectKey,
                                      java.lang.String username)

Adds user to list of project allowed reviewer users

Returns:

true if added or false if user was already in the list

deleteProjectAllowedReviewerUser

boolean deleteProjectAllowedReviewerUser(java.lang.String projectKey,
                                         java.lang.String username)

Deletes user from list of project allowed reviewer users

Returns:

true if deleted or false if user was not in list

getProjectAllowedReviewerGroups

Page<java.lang.String> getProjectAllowedReviewerGroups(java.lang.String projectKey,
                                                       PageRequest pageRequest)

Get paged list of project allowed users

Returns:

Page of user names

getProjectAllowedReviewerGroupsIterable

java.lang.Iterable<java.lang.String> getProjectAllowedReviewerGroupsIterable(java.lang.String projectKey,
                                                                             PageRequest pageRequest)

Returns a service-object as an Iterable used to iterate over project allowed reviewer groups Note: this Iterator will make a number of calls to the project service lazily (on Iterator.next() or Iterator.hasNext()) until all pages are retrieved. firstPageRequest is used to get the first page, following page requests will be created from Page.getNextPageRequest()

addProjectAllowedReviewerGroup

boolean addProjectAllowedReviewerGroup(java.lang.String projectKey,
                                       java.lang.String groupName)

Adds group to list of project allowed reviewer groups

Returns:

true if added or false if group was already in the list

deleteProjectAllowedReviewerGroup

boolean deleteProjectAllowedReviewerGroup(java.lang.String projectKey,
                                          java.lang.String groupName)

Deletes group from list of project allowed reviewer groups

Returns:

true if added or false if group was already in the list

exist

boolean exist(java.lang.String projectKey)

Checks it project with given key exists.

Returns:

true if project with key exists

getProject

@Deprecated
ProjectData getProject(java.lang.Integer id)

Deprecated.

Get a project from its internal id

hasPermission

boolean hasPermission(java.lang.String projectKey,
                      java.lang.String actionName)

Does the current user have this permission at a project level?

moveAllReviews

void moveAllReviews(java.lang.String sourceProjectKey,
                    java.lang.String destinationProjectKey)
             throws java.lang.IllegalArgumentException

Moves all reviews and snippets from project with sourceProjectKey to project with destinationProjectKey

Parameters:

sourceProjectKey - key of the project to move all reviews and snippets from

destinationProjectKey - key of the project to move reviews and snippets to.

Throws:

java.lang.IllegalArgumentException - if source or destination projects not found or if source and destination keys are referencing the same project.

Since:

3.5