1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    * Permission is hereby granted, free of charge, to any person obtaining a copy
5    * of this software and associated documentation files (the "Software"), to deal
6    * in the Software without restriction, including without limitation the rights
7    * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8    * copies of the Software, and to permit persons to whom the Software is
9    * furnished to do so, subject to the following conditions:
10   *
11   * The above copyright notice and this permission notice shall be included in
12   * all copies or substantial portions of the Software.
13   *
14   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15   * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16   * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17   * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18   * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19   * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20   * SOFTWARE.
21   */
22  
23  package com.liferay.portal.kernel.bi.reporting;
24  
25  import java.util.Map;
26  
27  import javax.servlet.ServletContext;
28  
29  /**
30   * <a href="ReportEngine.java.html"><b><i>View Source</i></b></a>
31   *
32   * @author Michael C. Han
33   */
34  public interface ReportEngine {
35  
36      public void compile(ReportRequest reportRequest)
37          throws ReportGenerationException;
38  
39      public void destroy();
40  
41      public void execute(
42              ReportRequest reportRequest,
43              ReportResultContainer reportResultContainer)
44          throws ReportGenerationException;
45  
46      public Map<String, String> getEngineParameters();
47  
48      public void init(ServletContext servletContext);
49  
50      public void setEngineParameters(Map<String, String> engineParameters);
51  
52      public void setReportFormatExporterRepository(
53          ReportFormatExporterRegistry reportFormatExporterRegistry);
54  
55  }