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