com.atlassian.crucible.spi.services

Interface ProjectService

public interface ProjectService

Provides an API for working with Projects

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	hasPermission(java.lang.String projectKey, java.lang.String actionName) Does the current user have this permission at a project level?

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.

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.

Returns:

getProject

ProjectData getProject(java.lang.String projectKey)

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

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.

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?