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;
18
19 import com.atlassian.jira.rest.client.domain.Component;
20 import com.atlassian.jira.rest.client.domain.input.ComponentInput;
21
22 import javax.annotation.Nullable;
23 import java.net.URI;
24
25 /**
26 * The client handling component resources
27 *
28 * @since v0.1
29 */
30 public interface ComponentRestClient {
31 /**
32 * @param componentUri URI to selected component resource
33 * @param progressMonitor progress monitor
34 * @return complete information about selected component
35 * @throws RestClientException in case of problems (connectivity, malformed messages, etc.)
36 */
37 Component getComponent(URI componentUri, ProgressMonitor progressMonitor);
38
39 Component createComponent(String projectKey, ComponentInput componentInput, ProgressMonitor progressMonitor);
40
41 Component updateComponent(URI componentUri, ComponentInput componentInput, ProgressMonitor progressMonitor);
42
43 void removeComponent(URI componentUri, @Nullable URI moveIssueToComponentUri, ProgressMonitor progressMonitor);
44
45 int getComponentRelatedIssuesCount(URI componentUri, ProgressMonitor progressMonitor);
46 }