View Javadoc
1   /*
2    * The Kuali Financial System, a comprehensive financial management system for higher education.
3    * 
4    * Copyright 2005-2014 The Kuali Foundation
5    * 
6    * This program is free software: you can redistribute it and/or modify
7    * it under the terms of the GNU Affero General Public License as
8    * published by the Free Software Foundation, either version 3 of the
9    * License, or (at your option) any later version.
10   * 
11   * This program is distributed in the hope that it will be useful,
12   * but WITHOUT ANY WARRANTY; without even the implied warranty of
13   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14   * GNU Affero General Public License for more details.
15   * 
16   * You should have received a copy of the GNU Affero General Public License
17   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18   */
19  package org.kuali.kfs.sys.service;
20  
21  /**
22   * This interface specifies a ReportWriterService that needs to be aware of the document number when
23   * generating reports.
24   * 
25   * Note that the implementing service may need to implement mechanisms to ensure that if multiple reports are 
26   * generated using this service (in particular the same instance), that each report uses the proper document number.
27   */
28  public interface DocumentNumberAwareReportWriterService extends ReportWriterService {
29      /**
30       * Sets the document number
31       * @param documentNumber
32       */
33      public void setDocumentNumber(String documentNumber);
34  }