View Javadoc

1   /*
2    * Copyright 2005-2008 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  
17  package org.kuali.rice.kns.datadictionary;
18  
19  import java.io.Serializable;
20  
21  /**
22   * Defines methods common to all DataDictionaryDefinition types.
23   * 
24   * 
25   */
26  public interface DataDictionaryDefinition extends Serializable {
27      /**
28       * Performs complete intra-definition validation which couldn't be done earlier - for example, verifies that field references
29       * refer to actual fields of some specific class.
30       * 
31       * @param rootBusinessObjectClass Class of the BusinessObjectEntry which ultimately contains this definition
32       * @param otherBusinessObjectClass other stuff required to complete validation
33       * @throws org.kuali.rice.kns.datadictionary.exception.CompletionException if a problem arises during validation-completion
34       */
35      public void completeValidation(Class rootBusinessObjectClass, Class otherBusinessObjectClass);
36      
37      public String getId();
38  }