com.atlassian.jira.bc.projectroles

Interface ProjectRoleService

All Known Implementing Classes:

DefaultProjectRoleService

@PublicApi
public interface ProjectRoleService

This is the business layer component that must be used to access all ProjectRole functionality. This will perform validation before it hands off to the project role manager. Operations will not be performed if validation fails.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROJECTROLE_ISSUE_SECURITY_TYPE
static String	PROJECTROLE_NOTIFICATION_TYPE
static String	PROJECTROLE_PERMISSION_TYPE

Method Summary

Modifier and Type	Method and Description
void	addActorsToProjectRole(ApplicationUser currentUser, Collection<String> actors, ProjectRole projectRole, Project project, String actorType, ErrorCollection errorCollection) Deprecated. Use addActorsToProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will add project role actor associations for the given actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	addActorsToProjectRole(Collection<String> actors, ProjectRole projectRole, Project project, String actorType, ErrorCollection errorCollection)
void	addDefaultActorsToProjectRole(ApplicationUser currentUser, Collection<String> actors, ProjectRole projectRole, String type, ErrorCollection errorCollection) Deprecated. Use addActorsToProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will add default role actor associations based off the passed in actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	addDefaultActorsToProjectRole(Collection<String> actors, ProjectRole projectRole, String type, ErrorCollection errorCollection)
ProjectRole	createProjectRole(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use createProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will create the project role with the given projectRole.getName(), projectRole.getDescription() and checking the currentUser has the correct permissions to perform the create operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
ProjectRole	createProjectRole(ProjectRole projectRole, ErrorCollection errorCollection)
void	deleteProjectRole(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use deleteProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will delete the given projectRole and checks the currentUser has the correct permissions to perform the delete operation. This will also delete all ProjectRoleActor associations that it is the parent of. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	deleteProjectRole(ProjectRole projectRole, ErrorCollection errorCollection)
Collection	getAssociatedIssueSecuritySchemes(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use getAssociatedIssueSecuritySchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will get all issue security scheme's that the specified projectRole is currently used in.
Collection	getAssociatedIssueSecuritySchemes(ProjectRole projectRole, ErrorCollection errorCollection)
Collection	getAssociatedNotificationSchemes(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use getAssociatedNotificationSchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will get all notification scheme's that the specified projectRole is currently used in.
Collection	getAssociatedNotificationSchemes(ProjectRole projectRole, ErrorCollection errorCollection)
Collection	getAssociatedPermissionSchemes(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use getAssociatedPermissionSchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will get all permission scheme's that the specified projectRole is currently used in.
Collection	getAssociatedPermissionSchemes(ProjectRole projectRole, ErrorCollection errorCollection)
org.apache.commons.collections.MultiMap	getAssociatedWorkflows(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use getAssociatedWorkflows(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Returns workflows and their actions that are associated with the given ProjectRole. e.g. com.atlassian.jira.workflow.condition.InProjectRoleCondition workflow elements that block workflow transition unless the acting user is in the ProjectRole.
org.apache.commons.collections.MultiMap	getAssociatedWorkflows(ProjectRole projectRole, ErrorCollection errorCollection)
DefaultRoleActors	getDefaultRoleActors(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection collection) Deprecated. Use getProjectRoleActors(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will return a DefaultRoleActors for the given projectRole checking the currentUser has the correct permissions to perform the get operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
DefaultRoleActors	getDefaultRoleActors(ProjectRole projectRole, ErrorCollection collection)
Map<Long,List<String>>	getProjectIdsForUserInGroupsBecauseOfRole(ApplicationUser currentUser, List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String userName, ErrorCollection errorCollection) Deprecated. Use getProjectIdsForUserInGroupsBecauseOfRole(java.util.List, com.atlassian.jira.security.roles.ProjectRole, String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Returns a Map of Lists. The key of the map is a Long, project id and the value of the map is a list of group names that the user is a member of for the project. This method is meant to provide an efficient means to discover which groups that are associated with a project role implicitly include the specified user in that project role. We allow you to specify a range of projectsToLimitBy so that you can perform only one query to find this information for many projects for a single projectRole.
Map<Long,List<String>>	getProjectIdsForUserInGroupsBecauseOfRole(List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String userName, ErrorCollection errorCollection)
ProjectRole	getProjectRole(ApplicationUser currentUser, Long id, ErrorCollection errorCollection) Deprecated. Use getProjectRole(Long, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will return the project role with the given id, and checking the currentUser has the correct permissions to perform the operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
ProjectRole	getProjectRole(Long id, ErrorCollection errorCollection)
ProjectRoleActors	getProjectRoleActors(ApplicationUser currentUser, ProjectRole projectRole, Project project, ErrorCollection errorCollection) Deprecated. Use getProjectRoleActors(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will return a {@link ProjectRoleActors) for the given projectRole and project checking the currentUser has the correct permissions to perform the get operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
ProjectRoleActors	getProjectRoleActors(ProjectRole projectRole, Project project, ErrorCollection errorCollection)
ProjectRole	getProjectRoleByName(ApplicationUser currentUser, String name, ErrorCollection errorCollection) Deprecated. Use getProjectRoleByName(String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will return the project role with the given name, and checking the currentUser has the correct permissions to perform the operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
ProjectRole	getProjectRoleByName(String name, ErrorCollection errorCollection)
Collection<ProjectRole>	getProjectRoles(ApplicationUser currentUser, ErrorCollection errorCollection) Deprecated. Use getProjectRoles(com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Get all the ProjectRoles available in JIRA. Currently this list is global.
Collection<ProjectRole>	getProjectRoles(ErrorCollection errorCollection)
Collection<Project>	getProjectsContainingRoleActorByNameAndType(ApplicationUser currentUser, String name, String type, ErrorCollection errorCollection) Deprecated. Use getProjectsContainingRoleActorByNameAndType(String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Returns the Project's which contain a role actor of the specified name and type within any role. This is a method that is provided so that you can efficiently tell which users or groups have been associated with any role within projects.
Collection<Project>	getProjectsContainingRoleActorByNameAndType(String name, String type, ErrorCollection errorCollection)
boolean	hasProjectRolePermission(ApplicationUser currentUser, Project project) Deprecated. Use #hasProjectRolePermission(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.project.Project) instead. Since v6.0. Will have permission to modify roles if they are a JIRA admin or, if in enterprise, the user is a project administrator.
boolean	hasProjectRolePermission(Project project)
boolean	isProjectRoleNameUnique(ApplicationUser currentUser, String name, ErrorCollection errorCollection) Deprecated. Use isProjectRoleNameUnique(String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will tell you if a role name exists or not.
boolean	isProjectRoleNameUnique(String name, ErrorCollection errorCollection)
void	removeActorsFromProjectRole(ApplicationUser currentUser, Collection<String> actors, ProjectRole projectRole, Project project, String actorType, ErrorCollection errorCollection) Deprecated. Use removeActorsFromProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will remove project role actor associations for the given actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	removeActorsFromProjectRole(Collection<String> actors, ProjectRole projectRole, Project project, String actorType, ErrorCollection errorCollection)
void	removeAllRoleActorsByNameAndType(ApplicationUser currentUser, String name, String type, ErrorCollection errorCollection) Deprecated. Use removeAllRoleActorsByNameAndType(String, String, ErrorCollection) instead. Since v6.0. Will remove all role actors with the specified name and the specified type. This method should be used to clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system).
void	removeAllRoleActorsByNameAndType(String name, String type) Deprecated. Use removeAllRoleActorsByNameAndType(String, String, com.atlassian.jira.util.ErrorCollection) (String, String)} instead. Since v6.0. Will remove all role actors with the specified name and the specified type. This method should be used to clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system).
void	removeAllRoleActorsByNameAndType(String name, String type, ErrorCollection errorCollection)
void	removeAllRoleActorsByProject(ApplicationUser currentUser, Project project, ErrorCollection errorCollection) Deprecated. Use removeAllRoleActorsByProject(com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will remove all role actors associated with the specified project. This method should be used to clean up just before the actual project has been deleted (ex. deleting a project from the system).
void	removeAllRoleActorsByProject(Project project, ErrorCollection errorCollection)
void	removeDefaultActorsFromProjectRole(ApplicationUser currentUser, Collection<String> actors, ProjectRole projectRole, String actorType, ErrorCollection errorCollection) Deprecated. Use removeDefaultActorsFromProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will remove default actor associations based off the passed in actors, projectRole and actorType and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	removeDefaultActorsFromProjectRole(Collection<String> actors, ProjectRole projectRole, String actorType, ErrorCollection errorCollection)
List<Long>	roleActorOfTypeExistsForProjects(ApplicationUser currentUser, List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String projectRoleParameter, ErrorCollection errorCollection) Deprecated. Use roleActorOfTypeExistsForProjects(java.util.List, com.atlassian.jira.security.roles.ProjectRole, String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Returns a list of projectId's for which the role actor of the specified type exists in the project for the provided projectRole. This is a method that is meant to efficiently allow discovery of whether a UserRoleActor exists in a project role for a subset of projects.
List<Long>	roleActorOfTypeExistsForProjects(List<Long> projectsToLimitBy, ProjectRole projectRole, String projectRoleType, String projectRoleParameter, ErrorCollection errorCollection)
void	setActorsForProjectRole(ApplicationUser currentUser, Map<String,Set<String>> newRoleActors, ProjectRole projectRole, Project project, ErrorCollection errorCollection) Deprecated. Use setActorsForProjectRole(java.util.Map, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will set the project role actor associations for the given newRoleActors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	setActorsForProjectRole(Map<String,Set<String>> newRoleActors, ProjectRole projectRole, Project project, ErrorCollection errorCollection)
void	swapRole(ProjectRole role, ProjectRole swapRole) Swaps a role in scheme entities, workflows, comments and worklogs for a replacement role.
void	updateProjectRole(ApplicationUser currentUser, ProjectRole projectRole, ErrorCollection errorCollection) Deprecated. Use updateProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will update projectRole, checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.
void	updateProjectRole(ProjectRole projectRole, ErrorCollection errorCollection)
ServiceResult	validateNoRoleUsage(ProjectRole projectRole) Checks if the given role is not used.
ErrorCollection	validateRemoveAllRoleActorsByNameAndType(ApplicationUser currentUser, String name, String type) Deprecated. Use removeAllRoleActorsByNameAndType(String, String) instead. Since v6.0. Will validate removing all role actors with the specified name and the specified type. This method should be used before clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system). Validation error wil be reported when name does not exists, type does not exists or user performing validation does not have administrative rights
ErrorCollection	validateRemoveAllRoleActorsByNameAndType(String name, String type)

Field Detail

PROJECTROLE_ISSUE_SECURITY_TYPE

static final String PROJECTROLE_ISSUE_SECURITY_TYPE

See Also:

Constant Field Values

PROJECTROLE_PERMISSION_TYPE

static final String PROJECTROLE_PERMISSION_TYPE

See Also:

Constant Field Values

PROJECTROLE_NOTIFICATION_TYPE

static final String PROJECTROLE_NOTIFICATION_TYPE

See Also:

Constant Field Values

Method Detail

getProjectRoles

Collection<ProjectRole> getProjectRoles(ErrorCollection errorCollection)

getProjectRoles

Collection<ProjectRole> getProjectRoles(ApplicationUser currentUser,
                                        ErrorCollection errorCollection)

Deprecated. Use getProjectRoles(com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Get all the ProjectRoles available in JIRA. Currently this list is global.

Returns:

The global list of project roles in JIRA

getProjectRole

ProjectRole getProjectRole(Long id,
                           ErrorCollection errorCollection)

getProjectRole

ProjectRole getProjectRole(ApplicationUser currentUser,
                           Long id,
                           ErrorCollection errorCollection)

Deprecated. Use getProjectRole(Long, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will return the project role with the given id, and checking the currentUser has the correct permissions to perform the operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

id - the id of the ProjectRole

errorCollection - will contain any errors in calling the method

Returns:

the ProjectRole for the given id, will return null if no role found

getProjectRoleByName

ProjectRole getProjectRoleByName(String name,
                                 ErrorCollection errorCollection)

getProjectRoleByName

ProjectRole getProjectRoleByName(ApplicationUser currentUser,
                                 String name,
                                 ErrorCollection errorCollection)

Deprecated. Use getProjectRoleByName(String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will return the project role with the given name, and checking the currentUser has the correct permissions to perform the operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

name - the name of the project role to return

errorCollection - will contain any errors in calling the method

Returns:

the ProjectRole for the given name, will return null if no role found

createProjectRole

ProjectRole createProjectRole(ProjectRole projectRole,
                              ErrorCollection errorCollection)

createProjectRole

ProjectRole createProjectRole(ApplicationUser currentUser,
                              ProjectRole projectRole,
                              ErrorCollection errorCollection)

Deprecated. Use createProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will create the project role with the given projectRole.getName(), projectRole.getDescription() and checking the currentUser has the correct permissions to perform the create operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

projectRole - can not be null and will contain the name and description for the project role to create

errorCollection - will contain any errors in calling the method

Returns:

the ProjectRole object that was created

isProjectRoleNameUnique

boolean isProjectRoleNameUnique(String name,
                                ErrorCollection errorCollection)

isProjectRoleNameUnique

boolean isProjectRoleNameUnique(ApplicationUser currentUser,
                                String name,
                                ErrorCollection errorCollection)

Deprecated. Use isProjectRoleNameUnique(String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will tell you if a role name exists or not.

Parameters:

name - the name of the project role to check

Returns:

true if unique, false if one already exists with that name

deleteProjectRole

void deleteProjectRole(ProjectRole projectRole,
                       ErrorCollection errorCollection)

deleteProjectRole

void deleteProjectRole(ApplicationUser currentUser,
                       ProjectRole projectRole,
                       ErrorCollection errorCollection)

Deprecated. Use deleteProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will delete the given projectRole and checks the currentUser has the correct permissions to perform the delete operation. This will also delete all ProjectRoleActor associations that it is the parent of. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

projectRole -

errorCollection - will contain any errors in calling the method

addActorsToProjectRole

void addActorsToProjectRole(Collection<String> actors,
                            ProjectRole projectRole,
                            Project project,
                            String actorType,
                            ErrorCollection errorCollection)

addActorsToProjectRole

void addActorsToProjectRole(ApplicationUser currentUser,
                            Collection<String> actors,
                            ProjectRole projectRole,
                            Project project,
                            String actorType,
                            ErrorCollection errorCollection)

Deprecated. Use addActorsToProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will add project role actor associations for the given actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

actors - is a list of strings (e.g. user keys or group names) that the RoleActor impl should be able to handle

projectRole - is the project role to associate with

project - is the project to associate with

actorType - is a type that defines the type of role actor to instantiate (ex./ UserRoleActor.TYPE, GroupRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

removeActorsFromProjectRole

void removeActorsFromProjectRole(Collection<String> actors,
                                 ProjectRole projectRole,
                                 Project project,
                                 String actorType,
                                 ErrorCollection errorCollection)

removeActorsFromProjectRole

void removeActorsFromProjectRole(ApplicationUser currentUser,
                                 Collection<String> actors,
                                 ProjectRole projectRole,
                                 Project project,
                                 String actorType,
                                 ErrorCollection errorCollection)

Deprecated. Use removeActorsFromProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will remove project role actor associations for the given actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

actors - is a list of strings (e.g. user keys or group names) that the RoleActor impl should be able to handle

projectRole - is the project role to associate with

project - is the project to associate with

actorType - is a type that defines the type of role actor to instantiate (ex./ UserRoleActor.TYPE, GroupRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

setActorsForProjectRole

void setActorsForProjectRole(Map<String,Set<String>> newRoleActors,
                             ProjectRole projectRole,
                             Project project,
                             ErrorCollection errorCollection)

setActorsForProjectRole

void setActorsForProjectRole(ApplicationUser currentUser,
                             Map<String,Set<String>> newRoleActors,
                             ProjectRole projectRole,
                             Project project,
                             ErrorCollection errorCollection)

Deprecated. Use setActorsForProjectRole(java.util.Map, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will set the project role actor associations for the given newRoleActors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

newRoleActors - is a mapping of actor types to actor parameters that will be set for the project role

projectRole - is the project role to associate with

project - is the project to associate with

errorCollection - will contain any errors in calling the method

updateProjectRole

void updateProjectRole(ProjectRole projectRole,
                       ErrorCollection errorCollection)

updateProjectRole

void updateProjectRole(ApplicationUser currentUser,
                       ProjectRole projectRole,
                       ErrorCollection errorCollection)

Deprecated. Use updateProjectRole(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will update projectRole, checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

projectRole -

errorCollection - will contain any errors in calling the method

getProjectRoleActors

ProjectRoleActors getProjectRoleActors(ProjectRole projectRole,
                                       Project project,
                                       ErrorCollection errorCollection)

getProjectRoleActors

ProjectRoleActors getProjectRoleActors(ApplicationUser currentUser,
                                       ProjectRole projectRole,
                                       Project project,
                                       ErrorCollection errorCollection)

Deprecated. Use getProjectRoleActors(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will return a {@link ProjectRoleActors) for the given projectRole and project checking the currentUser has the correct permissions to perform the get operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

projectRole -

project -

errorCollection - will contain any errors in calling the method

Returns:

the ProjectRoleActor representing the projectRole and project

getDefaultRoleActors

DefaultRoleActors getDefaultRoleActors(ProjectRole projectRole,
                                       ErrorCollection collection)

getDefaultRoleActors

DefaultRoleActors getDefaultRoleActors(ApplicationUser currentUser,
                                       ProjectRole projectRole,
                                       ErrorCollection collection)

Deprecated. Use getProjectRoleActors(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will return a DefaultRoleActors for the given projectRole checking the currentUser has the correct permissions to perform the get operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

projectRole -

collection -

Returns:

the default role actors

addDefaultActorsToProjectRole

void addDefaultActorsToProjectRole(Collection<String> actors,
                                   ProjectRole projectRole,
                                   String type,
                                   ErrorCollection errorCollection)

addDefaultActorsToProjectRole

void addDefaultActorsToProjectRole(ApplicationUser currentUser,
                                   Collection<String> actors,
                                   ProjectRole projectRole,
                                   String type,
                                   ErrorCollection errorCollection)

Deprecated. Use addActorsToProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.project.Project, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will add default role actor associations based off the passed in actors and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

actors - is a list of strings (e.g. user keys or group names) that the RoleActor impl should be able to handle

projectRole - is the project role to associate with

type - is a type that defines the type of role actor to instantiate (ex./ UserRoleActor.TYPE, GroupRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

removeDefaultActorsFromProjectRole

void removeDefaultActorsFromProjectRole(Collection<String> actors,
                                        ProjectRole projectRole,
                                        String actorType,
                                        ErrorCollection errorCollection)

removeDefaultActorsFromProjectRole

void removeDefaultActorsFromProjectRole(ApplicationUser currentUser,
                                        Collection<String> actors,
                                        ProjectRole projectRole,
                                        String actorType,
                                        ErrorCollection errorCollection)

Deprecated. Use removeDefaultActorsFromProjectRole(java.util.Collection, com.atlassian.jira.security.roles.ProjectRole, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will remove default actor associations based off the passed in actors, projectRole and actorType and checking the currentUser has the correct permissions to perform the update operation. The passed in errorCollection will contain any errors that are generated, such as permission violations.

Parameters:

currentUser - the user performing the call

actors - is a list of strings (e.g. user keys or group names) that the RoleActor impl should be able to handle

projectRole - is the project role to associate with

actorType - is a type that defines the type of role actor to instantiate (ex./ UserRoleActor.TYPE, GroupRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

removeAllRoleActorsByNameAndType

void removeAllRoleActorsByNameAndType(String name,
                                      String type,
                                      ErrorCollection errorCollection)

removeAllRoleActorsByNameAndType

void removeAllRoleActorsByNameAndType(ApplicationUser currentUser,
                                      String name,
                                      String type,
                                      ErrorCollection errorCollection)

Deprecated. Use removeAllRoleActorsByNameAndType(String, String, ErrorCollection) instead. Since v6.0.

Will remove all role actors with the specified name and the specified type. This method should be used to clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system).

Parameters:

currentUser - the user performing the call

name - this is the name that the role actor is stored under (ex. username of 'admin', group name of 'jira-users')

type - this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

validateRemoveAllRoleActorsByNameAndType

ErrorCollection validateRemoveAllRoleActorsByNameAndType(String name,
                                                         String type)

validateRemoveAllRoleActorsByNameAndType

ErrorCollection validateRemoveAllRoleActorsByNameAndType(ApplicationUser currentUser,
                                                         String name,
                                                         String type)

Deprecated. Use removeAllRoleActorsByNameAndType(String, String) instead. Since v6.0.

Will validate removing all role actors with the specified name and the specified type. This method should be used before clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system). Validation error wil be reported when name does not exists, type does not exists or user performing validation does not have administrative rights

Parameters:

currentUser - the user performing the call

name - this is the name that the role actor is stored under (ex. username of 'admin', group name of 'jira-users')

type - this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE)

Returns:

errorCollection will contain any errors in calling the method

removeAllRoleActorsByNameAndType

void removeAllRoleActorsByNameAndType(String name,
                                      String type)

Deprecated. Use removeAllRoleActorsByNameAndType(String, String, com.atlassian.jira.util.ErrorCollection) (String, String)} instead. Since v6.0.

Will remove all role actors with the specified name and the specified type. This method should be used to clean up after the actual subject of the role actor has been deleted (ex. deleting a user from the system).

Parameters:

name - this is the name that the role actor is stored under (ex. username of 'admin', group name of 'jira-users')

type - this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE)

removeAllRoleActorsByProject

void removeAllRoleActorsByProject(Project project,
                                  ErrorCollection errorCollection)

removeAllRoleActorsByProject

void removeAllRoleActorsByProject(ApplicationUser currentUser,
                                  Project project,
                                  ErrorCollection errorCollection)

Deprecated. Use removeAllRoleActorsByProject(com.atlassian.jira.project.Project, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will remove all role actors associated with the specified project. This method should be used to clean up just before the actual project has been deleted (ex. deleting a project from the system).

Parameters:

currentUser - the user performing the call

project -

errorCollection - will contain any errors in calling the method

getAssociatedNotificationSchemes

Collection getAssociatedNotificationSchemes(ProjectRole projectRole,
                                            ErrorCollection errorCollection)

getAssociatedNotificationSchemes

Collection getAssociatedNotificationSchemes(ApplicationUser currentUser,
                                            ProjectRole projectRole,
                                            ErrorCollection errorCollection)

Deprecated. Use getAssociatedNotificationSchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will get all notification scheme's that the specified projectRole is currently used in.

Parameters:

currentUser - the user performing the call

projectRole -

errorCollection - will contain any errors in calling the method

Returns:

a collection of schemes, if no schemes are found this will be an empty collection.

getAssociatedPermissionSchemes

Collection getAssociatedPermissionSchemes(ProjectRole projectRole,
                                          ErrorCollection errorCollection)

getAssociatedPermissionSchemes

Collection getAssociatedPermissionSchemes(ApplicationUser currentUser,
                                          ProjectRole projectRole,
                                          ErrorCollection errorCollection)

Deprecated. Use getAssociatedPermissionSchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0. Will get all permission scheme's that the specified projectRole is currently used in.

Parameters:

currentUser - the user performing the call

projectRole -

errorCollection - will contain any errors in calling the method

Returns:

a collection of schemes, if no schemes are found this will be an empty collection.

getAssociatedIssueSecuritySchemes

Collection getAssociatedIssueSecuritySchemes(ProjectRole projectRole,
                                             ErrorCollection errorCollection)

getAssociatedIssueSecuritySchemes

Collection getAssociatedIssueSecuritySchemes(ApplicationUser currentUser,
                                             ProjectRole projectRole,
                                             ErrorCollection errorCollection)

Deprecated. Use getAssociatedIssueSecuritySchemes(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Will get all issue security scheme's that the specified projectRole is currently used in.

Parameters:

currentUser - the user performing the call

projectRole -

errorCollection - will contain any errors in calling the method

Returns:

a collection of schemes, if no schemes are found this will be an empty collection.

getAssociatedWorkflows

org.apache.commons.collections.MultiMap getAssociatedWorkflows(ProjectRole projectRole,
                                                               ErrorCollection errorCollection)

getAssociatedWorkflows

org.apache.commons.collections.MultiMap getAssociatedWorkflows(ApplicationUser currentUser,
                                                               ProjectRole projectRole,
                                                               ErrorCollection errorCollection)

Deprecated. Use getAssociatedWorkflows(com.atlassian.jira.security.roles.ProjectRole, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Returns workflows and their actions that are associated with the given ProjectRole. e.g. com.atlassian.jira.workflow.condition.InProjectRoleCondition workflow elements that block workflow transition unless the acting user is in the ProjectRole.

Parameters:

currentUser - the acting user.

projectRole - the project role.

errorCollection - will contain any errors in calling the method

Returns:

a possibly empty MultiMap of Workflow objects to List of Actions.

getProjectsContainingRoleActorByNameAndType

Collection<Project> getProjectsContainingRoleActorByNameAndType(String name,
                                                                String type,
                                                                ErrorCollection errorCollection)

getProjectsContainingRoleActorByNameAndType

Collection<Project> getProjectsContainingRoleActorByNameAndType(ApplicationUser currentUser,
                                                                String name,
                                                                String type,
                                                                ErrorCollection errorCollection)

Deprecated. Use getProjectsContainingRoleActorByNameAndType(String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Returns the Project's which contain a role actor of the specified name and type within any role. This is a method that is provided so that you can efficiently tell which users or groups have been associated with any role within projects.

Parameters:

currentUser - the acting user.

name - this is the name that the role actor is stored under (ex. username of 'admin', group name of 'jira-users')

type - this is the role type parameter, (ex. GroupRoleActor.TYPE, UserRoleActor.TYPE)

errorCollection - will contain any errors in calling the method

Returns:

a collection of Project's which have a role which contains the role actor with the specified name and type.

roleActorOfTypeExistsForProjects

List<Long> roleActorOfTypeExistsForProjects(List<Long> projectsToLimitBy,
                                            ProjectRole projectRole,
                                            String projectRoleType,
                                            String projectRoleParameter,
                                            ErrorCollection errorCollection)

roleActorOfTypeExistsForProjects

List<Long> roleActorOfTypeExistsForProjects(ApplicationUser currentUser,
                                            List<Long> projectsToLimitBy,
                                            ProjectRole projectRole,
                                            String projectRoleType,
                                            String projectRoleParameter,
                                            ErrorCollection errorCollection)

Deprecated. Use roleActorOfTypeExistsForProjects(java.util.List, com.atlassian.jira.security.roles.ProjectRole, String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Returns a list of projectId's for which the role actor of the specified type exists in the project for the provided projectRole. This is a method that is meant to efficiently allow discovery of whether a UserRoleActor exists in a project role for a subset of projects.

Parameters:

currentUser - the acting user.

projectsToLimitBy - this will limit the range of projects the method queries. This is a list of Long, project id's. The returned list will be either the same as this list or a subset.

projectRole - the project role to find out if an actor is a member of.

projectRoleType - the type of role actor you want to query for, in most cases this will be UserRoleActor.TYPE.

projectRoleParameter - the parameter describing the role actor, in the case of a UserRoleActor this will be the username.

errorCollection - will contain any errors in calling the method

Returns:

A list of Long, project id's. If a projectId is in this list then the project contains has a role associated for the passed in actor and project role.

getProjectIdsForUserInGroupsBecauseOfRole

Map<Long,List<String>> getProjectIdsForUserInGroupsBecauseOfRole(List<Long> projectsToLimitBy,
                                                                 ProjectRole projectRole,
                                                                 String projectRoleType,
                                                                 String userName,
                                                                 ErrorCollection errorCollection)

getProjectIdsForUserInGroupsBecauseOfRole

Map<Long,List<String>> getProjectIdsForUserInGroupsBecauseOfRole(ApplicationUser currentUser,
                                                                 List<Long> projectsToLimitBy,
                                                                 ProjectRole projectRole,
                                                                 String projectRoleType,
                                                                 String userName,
                                                                 ErrorCollection errorCollection)

Deprecated. Use getProjectIdsForUserInGroupsBecauseOfRole(java.util.List, com.atlassian.jira.security.roles.ProjectRole, String, String, com.atlassian.jira.util.ErrorCollection) instead. Since v6.0.

Returns a Map of Lists. The key of the map is a Long, project id and the value of the map is a list of group names that the user is a member of for the project. This method is meant to provide an efficient means to discover which groups that are associated with a project role implicitly include the specified user in that project role. We allow you to specify a range of projectsToLimitBy so that you can perform only one query to find this information for many projects for a single projectRole.

Parameters:

currentUser - the acting user.

projectsToLimitBy - this will limit the range of projects the method queries. This is a list of Long, project id's. The returned list will be either the same as this list or a subset.

projectRole - the project role to find out if an actor is a member of.

projectRoleType - the type of role actor you want to query for, in most cases this will be UserRoleActor.TYPE.

userName - the username to find out if the user is in the role because of a group

errorCollection - will contain any errors in calling the method

Returns:

Returns a Map of Lists. The key of the map is a Long, project id and the value of the map is a list of group names that the user is a member of for the project.

hasProjectRolePermission

boolean hasProjectRolePermission(Project project)

hasProjectRolePermission

boolean hasProjectRolePermission(ApplicationUser currentUser,
                                 Project project)

Deprecated. Use #hasProjectRolePermission(com.atlassian.crowd.embedded.api.User, com.atlassian.jira.project.Project) instead. Since v6.0.

Will have permission to modify roles if they are a JIRA admin or, if in enterprise, the user is a project administrator.

Parameters:

currentUser - the acting user.

project - is the project to check permissions against

Returns:

true if you have permission, false otherwise.

validateNoRoleUsage

ServiceResult validateNoRoleUsage(ProjectRole projectRole)

Checks if the given role is not used. Looks in all schemes, workflows, comments and worklogs.

Parameters:

projectRole - the project role to check.

Returns:

ServiceResult containing any errors in validation

swapRole

void swapRole(ProjectRole role,
              ProjectRole swapRole)

Swaps a role in scheme entities, workflows, comments and worklogs for a replacement role.

Parameters:

role - the project role that will be replaced.

swapRole - project role that will replace the old role.