001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.sys.report;
017    
018    import java.util.Map;
019    import java.util.ResourceBundle;
020    
021    /**
022     * Hold the basic information of a report, for example, the names and locations of the output report and the report template.  
023     */
024    public interface ReportInfo {
025    
026        /**
027         * Gets the reportTitle attribute.
028         * 
029         * @return Returns the reportTitle.
030         */
031        public String getReportTitle();
032    
033        /**
034         * Gets the reportFileName attribute.
035         * 
036         * @return Returns the reportFileName.
037         */
038        public String getReportFileName();
039    
040        /**
041         * Gets the resourceBundleBaseName attribute.
042         * 
043         * @return Returns the resourceBundleBaseName.
044         */
045        public String getResourceBundleBaseName();
046    
047        /**
048         * Gets the reportTemplateName attribute.
049         * 
050         * @return Returns the reportTemplateName.
051         */
052        public String getReportTemplateName();
053    
054        /**
055         * Gets the reportTemplateClassPath attribute.
056         * 
057         * @return Returns the reportTemplateClassPath.
058         */
059        public String getReportTemplateClassPath();
060    
061        /**
062         * Gets the subReportTemplateClassPath attribute.
063         * 
064         * @return Returns the subReportTemplateClassPath.
065         */
066        public String getSubReportTemplateClassPath();
067    
068        /**
069         * Gets the subReports attribute.
070         * 
071         * @return Returns the subReports.
072         */
073        public Map<String, String> getSubReports();
074    
075        /**
076         * Gets the reportsDirectory attribute.
077         * 
078         * @return Returns the reportsDirectory.
079         */
080        public String getReportsDirectory();
081    
082        /**
083         * get the resource bundle
084         */
085        public ResourceBundle getResourceBundle();
086    
087    }