KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > jaspersoft > jasperserver > api > metadata > jasperreports > domain > ReportUnit


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.metadata.jasperreports.domain;
22
23 import java.util.List JavaDoc;
24
25 import com.jaspersoft.jasperserver.api.common.domain.ValidationResult;
26 import com.jaspersoft.jasperserver.api.metadata.common.domain.FileResource;
27 import com.jaspersoft.jasperserver.api.metadata.common.domain.InputControl;
28 import com.jaspersoft.jasperserver.api.metadata.common.domain.Resource;
29 import com.jaspersoft.jasperserver.api.metadata.common.domain.ResourceReference;
30
31 /**
32  * @author Teodor Danciu (teodord@users.sourceforge.net)
33  * @version $Id: ReportUnit.java 4335 2006-08-27 12:04:14Z swood $
34  */
35 public interface ReportUnit extends Resource {
36
37     /**
38      * Returns the reference to the
39      * {@link com.jaspersoft.jasperserver.api.metadata.jasperreports.domain.ReportDataSource data source}
40      * used by this report unit.
41      *
42      * @return a reference to the data source used by this report unit
43      */
44     public ResourceReference getDataSource();
45     
46     public void setDataSource(ResourceReference dataSourceReference);
47     
48     public void setDataSource(ReportDataSource dataSource);
49     
50     public void setDataSourceReference(String JavaDoc referenceURI);
51
52     /**
53      * Returns the reference to the
54      * {@link com.jaspersoft.jasperserver.api.metadata.common.domain.Query query}
55      * used by this report unit.
56      *
57      * @return a reference to the query used by this report unit
58      */
59     public ResourceReference getQuery();
60     
61     public void setQuery(ResourceReference queryReference);
62
63
64     /**
65      * Returns a list of {@link ResourceReference references} to
66      * {@link InputControl input controls}
67      * used by this report unit.
68      *
69      * @return a list of references to the input controls used by this report unit
70      */
71     public List JavaDoc getInputControls();
72     
73     public InputControl getInputControl(String JavaDoc name);
74
75     public void setInputControls(List JavaDoc inputControls);
76     
77     public void addInputControl(InputControl inputControl);
78     
79     public void addInputControl(ResourceReference inputControlReference);
80     
81     public void addInputControlReference(String JavaDoc referenceURI);
82     
83     public ResourceReference removeInputControl(int index);
84     
85     public boolean removeInputControlReference(String JavaDoc referenceURI);
86     
87     public InputControl removeInputControlLocal(String JavaDoc name);
88     
89     /**
90      * Returns the reference to the {@link FileResource JRXML resource}
91      * used by this report unit as master report
92      *
93      * @return a reference to the master report of this report unit
94      */
95     public ResourceReference getMainReport();
96     
97     public void setMainReport(ResourceReference reportReference);
98     
99     public void setMainReport(FileResource report);
100     
101     public void setMainReportReference(String JavaDoc referenceURI);
102
103     /**
104      *
105      */
106     public List JavaDoc getResources();
107
108     public FileResource getResourceLocal(String JavaDoc name);
109
110     public void setResources(List JavaDoc resources);
111     
112     public void addResource(FileResource resource);
113
114     public void addResource(ResourceReference resourceReference);
115     
116     public void addResourceReference(String JavaDoc referenceURI);
117     
118     public ResourceReference removeResource(int index);
119     
120     public FileResource removeResourceLocal(String JavaDoc name);
121     
122     public boolean removeResourceReference(String JavaDoc referenceURI);
123     
124     /**
125      *
126      */
127     
128     public void setInputControlRenderingView(String JavaDoc viewName);
129     public String JavaDoc getInputControlRenderingView();
130     
131     public void setReportRenderingView(String JavaDoc viewName);
132     public String JavaDoc getReportRenderingView();
133     /**
134      *
135      */
136     public ValidationResult validate();
137 }
138
Popular Tags