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.provider.annotation;
17
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Identifies the annotated class as an extension object for the given baseline class.
26 *
27 * <p>Inclusion of this annotation will perform the necessary wiring within JPA.</p>
28 *
29 * @author Kuali Rice Team (rice.collab@kuali.org)
30 *
31 */
32 @Target(ElementType.TYPE)
33 @Retention(RetentionPolicy.RUNTIME)
34 @Documented
35 public @interface ExtensionFor {
36
37 /**
38 * (Required) The class for which this one is an extension.
39 *
40 * @return the class for which this one is an extension.
41 */
42 Class<?> value();
43
44 /**
45 * (Optional) The name of the property on the source object which will hold the extension object.
46 *
47 * @return the name of the property on the source object which will hold the extension object.
48 */
49 String extensionPropertyName() default "extension";
50 }