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