View Javadoc

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 java.util.List;
20  
21  import org.apache.maven.reporting.MavenReportException;
22  import org.eclipse.mylyn.tasks.core.AbstractRepositoryConnector;
23  import org.eclipse.mylyn.tasks.core.data.TaskData;
24  
25  /**
26   * Simplifies the access to a remote repository. The facade is agnostic
27   * according to the type of repository.
28   *
29   * @author <a href="mailto:robert.reiner@smartics.de">Robert Reiner</a>
30   * @version $Revision:591 $
31   */
32  public interface RepositoryFacade
33  {
34    // ********************************* Fields *********************************
35  
36    // --- constants ------------------------------------------------------------
37  
38    // ****************************** Initializer *******************************
39  
40    // ****************************** Inner Classes *****************************
41  
42    // ********************************* Methods ********************************
43  
44    // --- get&set --------------------------------------------------------------
45  
46    /**
47     * Returns the connector used by this facade.
48     *
49     * @return the connector used by this facade.
50     */
51    AbstractRepositoryConnector getConnector();
52  
53    // --- business -------------------------------------------------------------
54  
55    /**
56     * Runs the query and returns the matching issues.
57     *
58     * @param queryData the query information.
59     * @return the matching tasks.
60     * @throws MavenReportException if a problem is encountered while fetching the
61     *           tasks.
62     * @todo throw another exception...
63     */
64    List<TaskData> queryTasks(QueryData queryData) throws MavenReportException;
65  
66    // --- object basics --------------------------------------------------------
67  
68  }