com.atlassian.jira.rest.client.api

Interface ComponentRestClient

public interface ComponentRestClient

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

Since:

v2.0

Method Summary

Methods

Modifier and Type	Method and Description
com.atlassian.util.concurrent.Promise<Component>	createComponent(String projectKey, ComponentInput componentInput)
com.atlassian.util.concurrent.Promise<Component>	getComponent(URI componentUri)
com.atlassian.util.concurrent.Promise<Integer>	getComponentRelatedIssuesCount(URI componentUri)
com.atlassian.util.concurrent.Promise<Void>	removeComponent(URI componentUri, URI moveIssueToComponentUri)
com.atlassian.util.concurrent.Promise<Component>	updateComponent(URI componentUri, ComponentInput componentInput)

Method Detail

getComponent

com.atlassian.util.concurrent.Promise<Component> getComponent(URI componentUri)

Parameters:

componentUri - URI to selected component resource

Returns:

complete information about selected component

Throws:

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

createComponent

com.atlassian.util.concurrent.Promise<Component> createComponent(String projectKey,
                                                               ComponentInput componentInput)

updateComponent

com.atlassian.util.concurrent.Promise<Component> updateComponent(URI componentUri,
                                                               ComponentInput componentInput)

removeComponent

com.atlassian.util.concurrent.Promise<Void> removeComponent(URI componentUri,
                                                          @Nullable
                                                          URI moveIssueToComponentUri)

getComponentRelatedIssuesCount

com.atlassian.util.concurrent.Promise<Integer> getComponentRelatedIssuesCount(URI componentUri)