1 /*
2 * Copyright (C) 2010 Atlassian
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.atlassian.jira.rest.client.api;
18
19 import com.atlassian.jira.rest.client.api.domain.Component;
20 import com.atlassian.jira.rest.client.api.domain.input.ComponentInput;
21 import com.atlassian.util.concurrent.Promise;
22
23 import javax.annotation.Nullable;
24 import java.net.URI;
25
26 /**
27 * The com.atlassian.jira.rest.client.api handling component resources
28 *
29 * @since v2.0
30 */
31 public interface ComponentRestClient {
32 /**
33 * @param componentUri URI to selected component resource
34 * @return complete information about selected component
35 * @throws RestClientException in case of problems (connectivity, malformed messages, etc.)
36 */
37 Promise<Component> getComponent(URI componentUri);
38
39 Promise<Component> createComponent(String projectKey, ComponentInput componentInput);
40
41 Promise<Component> updateComponent(URI componentUri, ComponentInput componentInput);
42
43 Promise<Void> removeComponent(URI componentUri, @Nullable URI moveIssueToComponentUri);
44
45 Promise<Integer> getComponentRelatedIssuesCount(URI componentUri);
46 }