1 /*
2 * Copyright 2008-2013 smartics, Kronseder & Reiner GmbH
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 package de.smartics.maven.issues;
17
18 import org.apache.maven.reporting.MavenReportException;
19
20 /**
21 * Contains the query parameters and allows to create a query URL to run against
22 * the issue management system.
23 *
24 * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
25 * @version $Revision:591 $
26 */
27 public interface QueryData
28 {
29 // ********************************* Fields *********************************
30
31 // --- constants ------------------------------------------------------------
32
33 // ****************************** Initializer *******************************
34
35 // ****************************** Inner Classes *****************************
36
37 // ********************************* Methods ********************************
38
39 // --- get&set --------------------------------------------------------------
40
41 // --- business -------------------------------------------------------------
42
43 /**
44 * Creates the query URL to run against the issue management system.
45 *
46 * @param connectionUrl the URL to the issue management system. The instance
47 * is responsible to add the name of the query service and the query
48 * parameters.
49 * @return the URL to fetch issues from the management system that match the
50 * criteria configured in this query data instance.
51 * @throws MavenReportException if the URL cannot be created.
52 * @todo change thrown exception...
53 */
54 String createUrl(String connectionUrl) throws MavenReportException;
55
56 // --- object basics --------------------------------------------------------
57
58 }