com.atlassian.jira.rest.client.api

Interface ProjectRolesRestClient

public interface ProjectRolesRestClient

The com.atlassian.jira.rest.client.api handling roles resources.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<ProjectRole>	getRole(URI uri) Retrieves a full information about the selected role.
com.atlassian.util.concurrent.Promise<ProjectRole>	getRole(URI projectUri, Long roleId) Retrieves a full information about the selected role.
com.atlassian.util.concurrent.Promise<Iterable<ProjectRole>>	getRoles(URI projectUri) Retrieves a collection of roles in the selected project.

Method Detail

getRole

com.atlassian.util.concurrent.Promise<ProjectRole> getRole(URI uri)

Retrieves a full information about the selected role.

Parameters:

uri - URI of the role to retrieve.

Returns:

full information about selected role.

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getRole

com.atlassian.util.concurrent.Promise<ProjectRole> getRole(URI projectUri,
                                                           Long roleId)

Retrieves a full information about the selected role.

Parameters:

projectUri - uri of the project of the role to retrieve.

roleId - unique role id.

Returns:

full information about selected role.

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)

getRoles

com.atlassian.util.concurrent.Promise<Iterable<ProjectRole>> getRoles(URI projectUri)

Retrieves a collection of roles in the selected project.

Parameters:

projectUri - uri of the project of the roles to retrieve.

Returns:

a collection of roles in the selected project.

Throws:

RestClientException - in case of problems (connectivity, malformed messages, etc.)