com.atlassian.jira.rest.client
Interface ProjectRolesRestClient

public interface ProjectRolesRestClient

The client handling roles resources.

Since:

1.0

Method Summary

ProjectRole	getRole(URI projectUri, Long roleId, ProgressMonitor progressMonitor) Retrieves a full information about the selected role.
ProjectRole	getRole(URI uri, ProgressMonitor progressMonitor) Retrieves a full information about the selected role.
Iterable<ProjectRole>	getRoles(URI projectUri, ProgressMonitor progressMonitor) Retrieves a collection of roles in the selected project.

Method Detail

getRole

ProjectRole getRole(URI uri,
                    ProgressMonitor progressMonitor)

Retrieves a full information about the selected role.

Parameters:

uri - URI of the role to retrieve.

progressMonitor - progress monitor.

Returns:

full information about selected role.

Throws:

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

getRole

ProjectRole getRole(URI projectUri,
                    Long roleId,
                    ProgressMonitor progressMonitor)

Retrieves a full information about the selected role.

Parameters:

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

roleId - unique role id.

progressMonitor - progress monitor.

Returns:

full information about selected role.

Throws:

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

getRoles

Iterable<ProjectRole> getRoles(URI projectUri,
                               ProgressMonitor progressMonitor)

Retrieves a collection of roles in the selected project.

Parameters:

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

progressMonitor - progress monitor.

Returns:

a collection of roles in the selected project.

Throws:

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