com.atlassian.jira.rest.v2.issue.project
Class ProjectRoleResource

java.lang.Object
  extended by com.atlassian.jira.rest.v2.issue.project.ProjectRoleResource

public class ProjectRoleResource
extends Object

Since:
v4.4

Field Summary
static Map<String,String> GET_ROLES_DOC_EXAMPLE
           
 
Constructor Summary
ProjectRoleResource(ProjectRoleService projectRoleService, AvatarService avatarService, ProjectService projectService, JiraAuthenticationContext authContext, javax.ws.rs.core.UriInfo uriInfo)
           
 
Method Summary
 javax.ws.rs.core.Response addActorUsers(String projectKey, Long id, Map<String,String[]> actors)
          Add an actor to a project role.
 javax.ws.rs.core.Response deleteActor(String projectKey, Long id, String username, String groupname)
          Remove actors from a project role.
 javax.ws.rs.core.Response getProjectRole(String projectKey, Long id)
          Details on a given project role.
 javax.ws.rs.core.Response getProjectRoles(String projectKey)
          Contains a list of roles in this project with links to full details.
 javax.ws.rs.core.Response setActors(String projectKey, Long id, ProjectRoleActorsUpdateBean actors)
          Updates a project role to contain the sent actors.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GET_ROLES_DOC_EXAMPLE

public static Map<String,String> GET_ROLES_DOC_EXAMPLE
Constructor Detail

ProjectRoleResource

public ProjectRoleResource(ProjectRoleService projectRoleService,
                           AvatarService avatarService,
                           ProjectService projectService,
                           JiraAuthenticationContext authContext,
                           javax.ws.rs.core.UriInfo uriInfo)
Method Detail

getProjectRoles

public javax.ws.rs.core.Response getProjectRoles(String projectKey)
Contains a list of roles in this project with links to full details.

Parameters:
projectKey - the project key
Returns:
list of roles and URIs to full details

getProjectRole

public javax.ws.rs.core.Response getProjectRole(String projectKey,
                                                Long id)
Details on a given project role.

Parameters:
projectKey - the project key
id - the project role id
Returns:
full details on the role and its actors. Actors are sorted by their display name.

setActors

public javax.ws.rs.core.Response setActors(String projectKey,
                                           Long id,
                                           ProjectRoleActorsUpdateBean actors)
Updates a project role to contain the sent actors.

Parameters:
projectKey - the project key
id - the project role id
actors - the actors to set for the role
Returns:
full details on the role and its actors after modification

addActorUsers

public javax.ws.rs.core.Response addActorUsers(String projectKey,
                                               Long id,
                                               Map<String,String[]> actors)
Add an actor to a project role.

Parameters:
projectKey - the project key
id - the project role id
actors - the actors to add to the role
Returns:
full details on the role and its actors after modification

deleteActor

public javax.ws.rs.core.Response deleteActor(String projectKey,
                                             Long id,
                                             @Nullable
                                             String username,
                                             @Nullable
                                             String groupname)
Remove actors from a project role.

Parameters:
projectKey - the project key
id - the project role id
username - the username to remove from the project role
groupname - the groupname to remove from the project role
Returns:
no content on success


Copyright © 2002-2011 Atlassian. All Rights Reserved.