View Javadoc

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