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