/**
 * Copyright 2005-2016 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.rice.krad.data.provider.annotation;

import com.google.common.annotations.Beta;

/**
 * BETA: Class representing the hints which can be passed through when auto-generating the input fields for an attribute.
 * 
 * @author Kuali Rice Team (rice.collab@kuali.org)
 */
@Beta
public @interface UifDisplayHint {

    /**
     * (Required) Gets the type of the display hint.
     *
     * @return the type of the display hint.
     */
	UifDisplayHintType value();

    /**
     * (Optional) Gets the section id for the {@link UifDisplayHintType} of SECTION.
     *
     * @return the section id for the {@link UifDisplayHintType} of SECTION.
     */
	String id() default "";

    /**
     * (Optional) Gets the section label for the {@link UifDisplayHintType} of SECTION.
     *
     * @return the section label for the {@link UifDisplayHintType} of SECTION.
     */
	String label() default "";
}
