001    /*
002     * Copyright 2007 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 1.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl1.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.rice.kns.service;
017    
018    import org.kuali.rice.krad.bo.BusinessObject;
019    import org.kuali.rice.krad.document.Document;
020    
021    /**
022     * @author Kuali Rice Team (rice.collab@kuali.org)
023     */
024    @Deprecated
025    public interface DictionaryValidationService extends org.kuali.rice.krad.service.DictionaryValidationService {
026    
027        /**
028         * Validates the contents of a document (i.e. attributes within a document) against the data dictionary.
029         * Recursively
030         * checks
031         * business objects of the document.
032         *
033         * @param document - document to validate
034         * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
035         * infinite.
036         * @deprecated Use {@link #validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document,
037         *             int, boolean)}
038         */
039        @Deprecated
040        public void validateDocumentRecursively(Document document, int depth);
041    
042        @Deprecated
043        public void validateBusinessObjectOnMaintenanceDocument(BusinessObject businessObject, String docTypeName);
044    
045        /**
046         * Validates the business object against the dictionary, uses reflection to get any child business objects, and
047         * recursively
048         * calls back. Adds errors to the map as they are encountered.
049         *
050         * @param businessObject - business object to validate
051         * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
052         * infinite.
053         * @deprecated since 1.1
054         */
055        @Deprecated
056        public void validateBusinessObjectsRecursively(BusinessObject businessObject, int depth);
057    
058        /**
059         * Validates an attribute of a given class for proper min, max length, syntax, and required.
060         *
061         * @param entryName - name of the dd entry
062         * @param attributeName - name of attribute in the bo class
063         * @param attributeValue - current value to validate
064         * @param errorKey - key to place the errors under
065         * @deprecated since 1.1
066         */
067        @Deprecated
068        public void validateAttributeFormat(String entryName, String attributeName, String attributeValue, String errorKey);
069    
070        /**
071         * Validates an attribute of a given class for proper min, max length, syntax, and required. The attribute will be
072         * validated
073         * according to the specified data type.
074         *
075         * @param entryName - name of the dd entry
076         * @param attributeName - name of attribute in the bo class
077         * @param attributeValue - current value to validate
078         * @param attributeDataType - data type that this attribute should be treated as for validation purposes
079         * @param errorKey - key to place the errors under
080         * @deprecated since 1.1
081         */
082        @Deprecated
083        public void validateAttributeFormat(String entryName, String attributeName, String attributeValue,
084                String attributeDataType, String errorKey);
085    
086        /**
087         * Validates an attribute of a given class for required check.
088         *
089         * @param entryName - name of the dd entry
090         * @param attributeName - name of attribute in the bo class
091         * @param attributeValue - current value to validate
092         * @param errorKey - key to place to errors under
093         * @deprecated since 1.1
094         */
095        @Deprecated
096        public void validateAttributeRequired(String entryName, String attributeName, Object attributeValue,
097                Boolean forMaintenance, String errorKey);
098    }