All Known Implementing Classes:
RolesImpl

public interface Roles
Responsible for representing the Project Roles Browser.

The Project Roles Browser is an administrative interface on JIRA's project roles.

Since:
v3.13
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addProjectRoleForUser(String projectName, String roleName, String userName)
    Adds a project role for a particular user.
    void
    create(String name, String description)
    Creates a project role with the specified name and description.
    void
    delete(long roleId)
    Deletes a project role with the specified id.
    void
    delete(String name)
    Deletes a project role with the specified name.
    edit(String name)
    Allows editing of a project role's details.
  • Method Details

    • delete

      void delete(long roleId)
      Deletes a project role with the specified id.
      Parameters:
      roleId - The id of the role to delete.
    • delete

      void delete(String name)
      Deletes a project role with the specified name.
      Parameters:
      name - The name of the role to delete.
    • addProjectRoleForUser

      void addProjectRoleForUser(String projectName, String roleName, String userName)
      Adds a project role for a particular user.
      Parameters:
      projectName - the name of the project.
      roleName - the name of the role to add.
      userName - the name of the user.
    • create

      void create(String name, String description)
      Creates a project role with the specified name and description.
      Parameters:
      name - The name of the specified role.
      description - The description of the specified role.
    • edit

      RoleDetails edit(String name)
      Allows editing of a project role's details.
      Parameters:
      name - The name of the project role to edit.
      Returns:
      A RoleDetails which allows to set the properties (i.e. name, description ...) of the project role in play.