001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.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/ecl2.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 */
016package org.kuali.rice.kns.service;
017
018import org.kuali.rice.krad.bo.BusinessObject;
019import org.kuali.rice.krad.document.Document;
020
021/**
022 * @author Kuali Rice Team (rice.collab@kuali.org)
023 *
024 * @deprecated Use {@link org.kuali.rice.krad.service.DictionaryValidationService}.
025 */
026@Deprecated
027public interface DictionaryValidationService extends org.kuali.rice.krad.service.DictionaryValidationService {
028
029    /**
030     * Validates the contents of a document (i.e. attributes within a document) against the data dictionary.
031     * Recursively
032     * checks
033     * business objects of the document.
034     *
035     * @param document - document to validate
036     * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
037     * infinite.
038     * @deprecated Use {@link #validateDocumentAndUpdatableReferencesRecursively(org.kuali.rice.krad.document.Document,
039     *             int, boolean)}
040     */
041    @Deprecated
042    public void validateDocumentRecursively(Document document, int depth);
043
044    @Deprecated
045    public void validateBusinessObjectOnMaintenanceDocument(BusinessObject businessObject, String docTypeName);
046
047    /**
048     * Validates the business object against the dictionary, uses reflection to get any child business objects, and
049     * recursively
050     * calls back. Adds errors to the map as they are encountered.
051     *
052     * @param businessObject - business object to validate
053     * @param depth - Specify how deep the recrusion should go (0 based). If a negative number is supplied, it's
054     * infinite.
055     * @deprecated since 1.1
056     */
057    @Deprecated
058    public void validateBusinessObjectsRecursively(Object businessObject, int depth);
059
060    /**
061     * Validates an attribute of a given class for proper min, max length, syntax, and required.
062     *
063     * @param entryName - name of the dd entry
064     * @param attributeName - name of attribute in the bo class
065     * @param attributeValue - current value to validate
066     * @param errorKey - key to place the errors under
067     * @deprecated since 1.1
068     */
069    @Deprecated
070    public void validateAttributeFormat(String entryName, String attributeName, String attributeValue, String errorKey);
071
072    /**
073     * Validates an attribute of a given class for proper min, max length, syntax, and required. The attribute will be
074     * validated
075     * according to the specified data type.
076     *
077     * @param entryName - name of the dd entry
078     * @param attributeName - name of attribute in the bo class
079     * @param attributeValue - current value to validate
080     * @param attributeDataType - data type that this attribute should be treated as for validation purposes
081     * @param errorKey - key to place the errors under
082     * @deprecated since 1.1
083     */
084    @Deprecated
085    public void validateAttributeFormat(String entryName, String attributeName, String attributeValue,
086            String attributeDataType, String errorKey);
087
088    /**
089     * Validates an attribute of a given class for required check.
090     *
091     * @param entryName - name of the dd entry
092     * @param attributeName - name of attribute in the bo class
093     * @param attributeValue - current value to validate
094     * @param errorKey - key to place to errors under
095     * @deprecated since 1.1
096     */
097    @Deprecated
098    public void validateAttributeRequired(String entryName, String attributeName, Object attributeValue,
099            Boolean forMaintenance, String errorKey);
100}