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.service;
017    
018    /**
019     * This interface specifies a ReportWriterService that needs to be aware of the document number when
020     * generating reports.
021     * 
022     * Note that the implementing service may need to implement mechanisms to ensure that if multiple reports are 
023     * generated using this service (in particular the same instance), that each report uses the proper document number.
024     */
025    public interface DocumentNumberAwareReportWriterService extends ReportWriterService {
026        /**
027         * Sets the document number
028         * @param documentNumber
029         */
030        public void setDocumentNumber(String documentNumber);
031    }