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 com.google.common.annotations.Beta;
19
20 import java.lang.annotation.Documented;
21 import java.lang.annotation.ElementType;
22 import java.lang.annotation.Retention;
23 import java.lang.annotation.RetentionPolicy;
24 import java.lang.annotation.Target;
25
26 /**
27 * Represents a property which should be inherited from another data object class.
28 *
29 * <p>Allows for the label to be overridden, but nothing else.</p>
30 *
31 * @author Kuali Rice Team (rice.collab@kuali.org)
32 */
33 @Target({ ElementType.FIELD, ElementType.METHOD })
34 @Retention(RetentionPolicy.RUNTIME)
35 @Documented
36 public @interface InheritProperty {
37
38 /**
39 * Gets the name of the property to be inherited.
40 *
41 * @return the name of the property to be inherited.
42 */
43 String name();
44
45 /**
46 * Gets the label to override.
47 *
48 * @return the label to override.
49 */
50 Label label() default @Label("");
51
52 /**
53 * BETA: Gets the hints which can be passed through when auto-generating the input fields for an attribute.
54 *
55 * @return the hints which can be passed through when auto-generating the input fields for an attribute.
56 */
57 @Beta
58 UifDisplayHints displayHints() default @UifDisplayHints(@UifDisplayHint(UifDisplayHintType.NONE));
59 }