1 /**
2 * Copyright 2005-2014 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.jpa;
17
18 import org.kuali.rice.krad.data.metadata.DataObjectRelationship;
19 import org.kuali.rice.krad.data.provider.MetadataProvider;
20
21 /**
22 * Subclass of the {@link MetadataProvider} which contains the additional methods needed.
23 *
24 * @author Kuali Rice Team (rice.collab@kuali.org)
25 */
26 public interface JpaMetadataProvider extends MetadataProvider {
27
28 /**
29 * Given the parameters, injects into the JPA repository a 1:1 relationship between the parent entity and the
30 * extension entity via the given property name (which must exist on the entityClass).
31 *
32 * @param entityClass
33 * The parent (owning) class which must be already known to the JPA persistence unit. This one's metadata
34 * will be modified within the internals of the JPA metadata.
35 * @param extensionPropertyName
36 * The property on the parent class which will hold the extensionEntity. This property must be of the
37 * type of the extension entity or a superclass. (Object will work.)
38 * @param extensionEntity
39 * The child/extension class which needs to be linked. It must also already be known to JPA.
40 * @return A 1:1 relationship between the parent entry and the extension entity via the given property name.
41 */
42 DataObjectRelationship addExtensionRelationship(Class<?> entityClass, String extensionPropertyName, Class<?> extensionEntity);
43
44 }