KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jaspersoft > jasperserver > api > engine > common > service > EngineService


1 /*
2  * Copyright (C) 2006 JasperSoft http://www.jaspersoft.com
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed WITHOUT ANY WARRANTY; and without the
10  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  * See the GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, see http://www.gnu.org/licenses/gpl.txt
15  * or write to:
16  *
17  * Free Software Foundation, Inc.,
18  * 59 Temple Place - Suite 330,
19  * Boston, MA USA 02111-1307
20  */

21 package com.jaspersoft.jasperserver.api.engine.common.service;
22
23 import java.util.List JavaDoc;
24 import java.util.Map JavaDoc;
25
26 import org.apache.commons.collections.OrderedMap;
27
28 import net.sf.jasperreports.engine.JasperReport;
29
30 import com.jaspersoft.jasperserver.api.common.domain.ExecutionContext;
31 import com.jaspersoft.jasperserver.api.common.domain.ValidationResult;
32 import com.jaspersoft.jasperserver.api.engine.common.domain.Request;
33 import com.jaspersoft.jasperserver.api.engine.common.domain.Result;
34 import com.jaspersoft.jasperserver.api.metadata.common.domain.Resource;
35 import com.jaspersoft.jasperserver.api.metadata.common.domain.ResourceReference;
36 import com.jaspersoft.jasperserver.api.metadata.jasperreports.domain.ReportUnit;
37 import com.jaspersoft.jasperserver.api.metadata.jasperreports.domain.ReportDataSource;
38 import com.jaspersoft.jasperserver.api.metadata.jasperreports.service.ReportDataSourceService;
39
40
41 /**
42  * @author Teodor Danciu (teodord@users.sourceforge.net)
43  * @version $Id: AbstractAttributedObject.java 2140 2006-02-21 06:41:21Z tony $
44  */

45 public interface EngineService
46 {
47
48     /**
49      *
50      */

51     public Result execute(ExecutionContext context, Request request);
52
53     /**
54      * Returns a list of required resources for the report such as images, fonts, subreports, etc.
55      */

56     public Resource[] getResources(ResourceReference jrxmlReference); //FIXME move this to a different interface or service
57

58     public ValidationResult validate(ExecutionContext context, ReportUnit reportUnit);
59
60     public JasperReport getMainJasperReport(ExecutionContext context, String JavaDoc reportUnitURI);
61
62     public void release();
63
64     public void clearCaches(Class JavaDoc resourceItf, String JavaDoc resourceURI);
65
66     public ReportDataSourceService createDataSourceService(ReportDataSource dataSource);
67
68     public void exportToPdf(ExecutionContext context, String JavaDoc reportUnitURI, Map JavaDoc exportParameters);
69     
70     public OrderedMap executeQuery(ExecutionContext context,
71             ResourceReference queryReference, String JavaDoc keyColumn, String JavaDoc[] resultColumns,
72             ResourceReference defaultDataSourceReference);
73 }
74
Popular Tags