View Javadoc
1   /*
2    * Kuali Coeus, a comprehensive research administration system for higher education.
3    * 
4    * Copyright 2005-2015 Kuali, Inc.
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.coeus.s2sgen.api.print;
20  
21  import org.kuali.coeus.s2sgen.api.core.S2SException;
22  
23  /**
24   *
25   * This service allows s2s forms to be retrieved in pdf form.
26   */
27  public interface FormPrintService {
28  
29      /**
30       * This service method executes form generation and validation where the result is a pdf document in binary form and
31       * any errors that were generated during this process. This happens for a given proposal development document.
32       * The proposal development document cannot be null.
33       *
34       * @param pdDoc the proposal development document.  cannot be null.
35       * @return the result of the pdf generation
36       * @throws S2SException if unable to generate the pdf
37       * @throws java.lang.IllegalArgumentException if the pdDoc is null
38       */
39      FormPrintResult printForm(Object pdDoc) throws S2SException;
40  }