View Javadoc
1   /**
2    * Copyright 2005-2015 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.krad.datadictionary;
17  
18  import java.io.Serializable;
19  
20  import org.kuali.rice.krad.datadictionary.validator.ValidationTrace;
21  
22  /**
23   * Defines methods common to all DataDictionaryDefinition types.
24   */
25  public interface DataDictionaryDefinition extends DictionaryBean, Serializable {
26  
27      /**
28       * Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field
29       * references
30       * refer to actual fields of some specific class.
31       *
32       * @param rootBusinessObjectClass Class of the BusinessObjectEntry which ultimately contains this definition
33       * @param otherBusinessObjectClass other stuff required to complete validation
34       * @throws org.kuali.rice.krad.datadictionary.exception.CompletionException if a problem arises during
35       * validation-completion
36       */
37      @Deprecated
38      void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass);
39  
40      /**
41       * Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field
42       * references
43       * refer to actual fields of some specific class.
44       *
45       * @param rootBusinessObjectClass Class of the BusinessObjectEntry which ultimately contains this definition
46       * @param otherBusinessObjectClass other stuff required to complete validation
47       * @param tracer {@link ValidationTrace} class used to track what was being validated at the time of any problems discovered
48       */
49      void completeValidation(Class<?> rootBusinessObjectClass, Class<?> otherBusinessObjectClass, ValidationTrace tracer);
50  
51      String getId();
52  }