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.validate;
20
21 import org.apache.xmlbeans.XmlObject;
22 import org.kuali.coeus.s2sgen.api.core.AuditError;
23
24 import java.util.List;
25
26
27 /**
28 *
29 * This class Forms the base for all XML Beans based validations to be done.
30 *
31 * @author Kuali Research Administration Team (kualidev@oncourse.iu.edu)
32 */
33 public interface S2SValidatorService {
34
35 String GRANTS_GOV_PREFIX = "/GrantApplication/Forms";
36
37
38 /**
39 *
40 * This method receives an XMLObject and validates it against its schema and returns the validation result. It also receives a
41 * list in which upon validation failure, populates it with XPaths of the error nodes
42 *
43 * @param formObject XML document as {@link}XMLObject
44 * @param errors List list of XPaths of the error nodes.
45 * @param formName is the FormName.
46 * @return validation result true if valid false otherwise.
47 */
48 boolean validate(XmlObject formObject, List<AuditError> errors, String formName);
49
50 }