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
020/**
021 * BETA: Class representing the hints which can be passed through when auto-generating the input fields for an attribute.
022 * 
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025@Beta
026public @interface UifDisplayHint {
027
028    /**
029     * (Required) Gets the type of the display hint.
030     *
031     * @return the type of the display hint.
032     */
033        UifDisplayHintType value();
034
035    /**
036     * (Optional) Gets the section id for the {@link UifDisplayHintType} of SECTION.
037     *
038     * @return the section id for the {@link UifDisplayHintType} of SECTION.
039     */
040        String id() default "";
041
042    /**
043     * (Optional) Gets the section label for the {@link UifDisplayHintType} of SECTION.
044     *
045     * @return the section label for the {@link UifDisplayHintType} of SECTION.
046     */
047        String label() default "";
048}