001/**
002 * Copyright 2005-2018 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.krad.datadictionary;
017
018import java.io.Serializable;
019
020import org.kuali.rice.krad.datadictionary.validator.ValidationTrace;
021
022/**
023 * Defines methods common to all DataDictionaryDefinition types.
024 */
025public interface DataDictionaryDefinition extends DictionaryBean, Serializable {
026
027    /**
028     * Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field
029     * references
030     * refer to actual fields of some specific class.
031     *
032     * @param rootBusinessObjectClass Class of the BusinessObjectEntry which ultimately contains this definition
033     * @param otherBusinessObjectClass other stuff required to complete validation
034     * @throws org.kuali.rice.krad.datadictionary.exception.CompletionException if a problem arises during
035     * validation-completion
036     */
037    @Deprecated
038    void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass);
039
040    /**
041     * Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field
042     * references
043     * refer to actual fields of some specific class.
044     *
045     * @param rootBusinessObjectClass Class of the BusinessObjectEntry which ultimately contains this definition
046     * @param otherBusinessObjectClass other stuff required to complete validation
047     * @param tracer {@link ValidationTrace} class used to track what was being validated at the time of any problems discovered
048     */
049    void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass, ValidationTrace tracer);
050
051    String getId();
052}