1 /*
2 * Copyright 2008 The Kuali Foundation
3 *
4 * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
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 org.kuali.ole.sys.report;
17
18 import java.util.Map;
19 import java.util.ResourceBundle;
20
21 /**
22 * Hold the basic information of a report, for example, the names and locations of the output report and the report template.
23 */
24 public interface ReportInfo {
25
26 /**
27 * Gets the reportTitle attribute.
28 *
29 * @return Returns the reportTitle.
30 */
31 public String getReportTitle();
32
33 /**
34 * Gets the reportFileName attribute.
35 *
36 * @return Returns the reportFileName.
37 */
38 public String getReportFileName();
39
40 /**
41 * Gets the resourceBundleBaseName attribute.
42 *
43 * @return Returns the resourceBundleBaseName.
44 */
45 public String getResourceBundleBaseName();
46
47 /**
48 * Gets the reportTemplateName attribute.
49 *
50 * @return Returns the reportTemplateName.
51 */
52 public String getReportTemplateName();
53
54 /**
55 * Gets the reportTemplateClassPath attribute.
56 *
57 * @return Returns the reportTemplateClassPath.
58 */
59 public String getReportTemplateClassPath();
60
61 /**
62 * Gets the subReportTemplateClassPath attribute.
63 *
64 * @return Returns the subReportTemplateClassPath.
65 */
66 public String getSubReportTemplateClassPath();
67
68 /**
69 * Gets the subReports attribute.
70 *
71 * @return Returns the subReports.
72 */
73 public Map<String, String> getSubReports();
74
75 /**
76 * Gets the reportsDirectory attribute.
77 *
78 * @return Returns the reportsDirectory.
79 */
80 public String getReportsDirectory();
81
82 /**
83 * get the resource bundle
84 */
85 public ResourceBundle getResourceBundle();
86
87 }