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.provider.annotation;
017
018import java.lang.annotation.Documented;
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Identifies the annotated class as an extension object for the given baseline class.
026 * 
027 * <p>Inclusion of this annotation will perform the necessary wiring within JPA.</p>
028 * 
029 * @author Kuali Rice Team (rice.collab@kuali.org)
030 * 
031 */
032@Target(ElementType.TYPE)
033@Retention(RetentionPolicy.RUNTIME)
034@Documented
035public @interface ExtensionFor {
036
037        /**
038     * (Required) The class for which this one is an extension.
039     *
040     * @return the class for which this one is an extension.
041     */
042        Class<?> value();
043
044        /**
045     * (Optional) The name of the property on the source object which will hold the extension object.
046     *
047     * @return the name of the property on the source object which will hold the extension object.
048     */
049        String extensionPropertyName() default "extension";
050}