001/**
002 * Copyright 2005-2016 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.data.jpa;
017
018import org.kuali.rice.krad.data.metadata.DataObjectRelationship;
019import org.kuali.rice.krad.data.provider.MetadataProvider;
020
021/**
022 * Subclass of the {@link MetadataProvider} which contains the additional methods needed.
023 *
024 * @author Kuali Rice Team (rice.collab@kuali.org)
025 */
026public interface JpaMetadataProvider extends MetadataProvider {
027
028        /**
029         * Given the parameters, injects into the JPA repository a 1:1 relationship between the parent entity and the
030     * extension entity via the given property name (which must exist on the entityClass).
031         * 
032         * @param entityClass
033         *            The parent (owning) class which must be already known to the JPA persistence unit. This one's metadata
034         *            will be modified within the internals of the JPA metadata.
035         * @param extensionPropertyName
036         *            The property on the parent class which will hold the extensionEntity. This property must be of the
037         *            type of the extension entity or a superclass. (Object will work.)
038         * @param extensionEntity
039         *            The child/extension class which needs to be linked. It must also already be known to JPA.
040     * @return A 1:1 relationship between the parent entry and the extension entity via the given property name.
041         */
042        DataObjectRelationship addExtensionRelationship(Class<?> entityClass, String extensionPropertyName, Class<?> extensionEntity);
043
044}