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.impl.generate;
20
21 import org.apache.xmlbeans.XmlOptions;
22 import org.kuali.coeus.s2sgen.api.core.S2SException;
23
24 /**
25 *
26 * This interface defines the service that is used to create instances of opportunity form generator classes.
27 *
28 * @author Kuali Research Administration Team (kualidev@oncourse.iu.edu)
29 */
30 public interface S2SFormGeneratorRetrievalService {
31
32 /**
33 *
34 * This method is used to create and return a form generator instance. Based on the namespace provided as parameter, it
35 * instantiates the respective generator class and returns it.
36 *
37 * @param nameSpace {@link String}
38 * @return S2SFormGenerator form generator instances corresponding to the name space.
39 * @throws S2SException
40 *
41 */
42 S2SFormGenerator getS2SGenerator(String proposalNumber,String nameSpace) throws S2SException;
43 /**
44 * This method is to get the namespace prefixes for some individual forms like, Subaward Budget and PHS398_ResearchTrainingProgramPlan
45 * @return
46 */
47 XmlOptions getXmlOptionsPrefixes();
48
49 }