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.XmlObject;
19 import org.kuali.coeus.s2sgen.api.core.S2SException;
20 import org.kuali.coeus.s2sgen.api.generate.AttachmentData;
21 import org.kuali.coeus.propdev.api.core.ProposalDevelopmentDocumentContract;
22 import org.kuali.coeus.s2sgen.api.core.AuditError;
23
24 import java.util.List;
25
26 /**
27 *
28 * This interface defines the core methods for the Form Generator classes and is meant to be implemented by all generators
29 *
30 * @author Kuali Research Administration Team (kualidev@oncourse.iu.edu)
31 */
32 public interface S2SFormGenerator {
33
34
35 /**
36 *
37 * This method creates an XML document using the APIs generated using XMLBeans by compiling the form's schema and returns it
38 * as XmlObject.
39 */
40 XmlObject getFormObject(ProposalDevelopmentDocumentContract proposalDevelopmentDocument) throws S2SException;
41
42 List<AttachmentData> getAttachments();
43
44 List<AuditError> getAuditErrors();
45 }