1 /**
2 * Copyright 2005-2016 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 /**
21 * BETA: Class representing the hints which can be passed through when auto-generating the input fields for an attribute.
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 @Beta
26 public @interface UifDisplayHint {
27
28 /**
29 * (Required) Gets the type of the display hint.
30 *
31 * @return the type of the display hint.
32 */
33 UifDisplayHintType value();
34
35 /**
36 * (Optional) Gets the section id for the {@link UifDisplayHintType} of SECTION.
37 *
38 * @return the section id for the {@link UifDisplayHintType} of SECTION.
39 */
40 String id() default "";
41
42 /**
43 * (Optional) Gets the section label for the {@link UifDisplayHintType} of SECTION.
44 *
45 * @return the section label for the {@link UifDisplayHintType} of SECTION.
46 */
47 String label() default "";
48 }