View Javadoc
1   /**
2    * Copyright 2005-2016 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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/ecl2.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.rice.kns.service;
17  
18  import org.kuali.rice.krad.bo.BusinessObject;
19  import org.kuali.rice.krad.document.Document;
20  
21  /**
22   * @author Kuali Rice Team (rice.collab@kuali.org)
23   *
24   * @deprecated Use {@link org.kuali.rice.krad.service.DictionaryValidationService}.
25   */
26  @Deprecated
27  public interface DictionaryValidationService extends org.kuali.rice.krad.service.DictionaryValidationService {
28  
29      /**
30       * Validates the contents of a document (i.e. attributes within a document) against the data dictionary.
31       * Recursively
32       * checks
33       * business objects of the document.
34       *
35       * @param document - document to validate
36       * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
37       * infinite.
38       * @deprecated Use {@link #validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document,
39       *             int, boolean)}
40       */
41      @Deprecated
42      public void validateDocumentRecursively(Document document, int depth);
43  
44      @Deprecated
45      public void validateBusinessObjectOnMaintenanceDocument(BusinessObject businessObject, String docTypeName);
46  
47      /**
48       * Validates the business object against the dictionary, uses reflection to get any child business objects, and
49       * recursively
50       * calls back. Adds errors to the map as they are encountered.
51       *
52       * @param businessObject - business object to validate
53       * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
54       * infinite.
55       * @deprecated since 1.1
56       */
57      @Deprecated
58      public void validateBusinessObjectsRecursively(Object businessObject, int depth);
59  
60      /**
61       * Validates an attribute of a given class for proper min, max length, syntax, and required.
62       *
63       * @param entryName - name of the dd entry
64       * @param attributeName - name of attribute in the bo class
65       * @param attributeValue - current value to validate
66       * @param errorKey - key to place the errors under
67       * @deprecated since 1.1
68       */
69      @Deprecated
70      public void validateAttributeFormat(String entryName, String attributeName, String attributeValue, String errorKey);
71  
72      /**
73       * Validates an attribute of a given class for proper min, max length, syntax, and required. The attribute will be
74       * validated
75       * according to the specified data type.
76       *
77       * @param entryName - name of the dd entry
78       * @param attributeName - name of attribute in the bo class
79       * @param attributeValue - current value to validate
80       * @param attributeDataType - data type that this attribute should be treated as for validation purposes
81       * @param errorKey - key to place the errors under
82       * @deprecated since 1.1
83       */
84      @Deprecated
85      public void validateAttributeFormat(String entryName, String attributeName, String attributeValue,
86              String attributeDataType, String errorKey);
87  
88      /**
89       * Validates an attribute of a given class for required check.
90       *
91       * @param entryName - name of the dd entry
92       * @param attributeName - name of attribute in the bo class
93       * @param attributeValue - current value to validate
94       * @param errorKey - key to place to errors under
95       * @deprecated since 1.1
96       */
97      @Deprecated
98      public void validateAttributeRequired(String entryName, String attributeName, Object attributeValue,
99              Boolean forMaintenance, String errorKey);
100 }