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