View Javadoc
1   /**
2    * Copyright 2005-2016 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.data.metadata;
17  
18  import java.io.Serializable;
19  
20  /**
21  * Parent and child attribute relationship.
22  *
23  * <p>
24  * Represents a relationship between a parent and child attribute. Used in the context of a {@link MetadataChild}
25  * object.
26  * </p>
27  *
28  * @author Kuali Rice Team (rice.collab@kuali.org)
29  */
30  public interface DataObjectAttributeRelationship extends Serializable {
31  
32      /**
33      * Gets attribute name of parent.
34      *
35      * <p>
36      * The property on the "parent" data object.
37      * </p>
38      *
39      * @return attribute name of parent
40      */
41      String getParentAttributeName();
42  
43      /**
44      * Gets matching child property.
45      *
46      * <p>
47      * The matching property on the "child", usually part of the child data object's primary key.
48      * </p>
49      *
50      * @return matching child property
51      */
52      String getChildAttributeName();
53  }