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 com.google.common.annotations.Beta;
019
020import java.lang.annotation.Documented;
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026/**
027 * Represents a property which should be inherited from another data object class.
028 *
029 * <p>Allows for the label to be overridden, but nothing else.</p>
030 *
031 * @author Kuali Rice Team (rice.collab@kuali.org)
032 */
033@Target({ ElementType.FIELD, ElementType.METHOD })
034@Retention(RetentionPolicy.RUNTIME)
035@Documented
036public @interface InheritProperty {
037
038    /**
039     * Gets the name of the property to be inherited.
040     *
041     * @return the name of the property to be inherited.
042     */
043        String name();
044
045    /**
046     * Gets the label to override.
047     *
048     * @return the label to override.
049     */
050        Label label() default @Label("");
051
052    /**
053     * BETA: Gets the hints which can be passed through when auto-generating the input fields for an attribute.
054     *
055     * @return the hints which can be passed through when auto-generating the input fields for an attribute.
056     */
057    @Beta
058        UifDisplayHints displayHints() default @UifDisplayHints(@UifDisplayHint(UifDisplayHintType.NONE));
059}