View Javadoc

1   /*
2    * Copyright 2006-2012 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.util.report.link;
17  
18  /**
19   * Factory to create external reports.
20   */
21  public interface ExternalReportFactory
22  {
23    // ********************************* Fields *********************************
24  
25    // --- constants ------------------------------------------------------------
26  
27    // ****************************** Initializer *******************************
28  
29    // ****************************** Inner Classes *****************************
30  
31    // ********************************* Methods ********************************
32  
33    // --- get&set --------------------------------------------------------------
34  
35    // --- business -------------------------------------------------------------
36  
37    /**
38     * Constructs an external report.
39     *
40     * @param reportId the identifier of the external report to create.
41     * @param strategy the strategy of the report.
42     * @return the instance of the external report or <code>null</code> if no
43     *         report data is provided.
44     */
45    ExternalReport createExternalReport(ReportId reportId,
46        LinkConstructorStrategy strategy);
47  
48    // --- object basics --------------------------------------------------------
49  }