1 /**
2 * Copyright 2005-2012 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.uif.component;
17
18 import java.lang.annotation.Documented;
19 import java.lang.annotation.ElementType;
20 import java.lang.annotation.Retention;
21 import java.lang.annotation.RetentionPolicy;
22 import java.lang.annotation.Target;
23
24 /**
25 * Annotation for <code>View</code> fields to indicate the field can be set by a
26 * parameter of the initial request
27 *
28 * @author Kuali Rice Team (rice.collab@kuali.org)
29 */
30 @Target({ ElementType.FIELD })
31 @Retention(RetentionPolicy.RUNTIME)
32 @Documented
33 public @interface RequestParameter {
34
35 /**
36 * Name of the request parameter whose value should be pulled to populate
37 * the field. If not set, any parameter that matches the name of the field
38 * will be used
39 *
40 * @return String request parameter name
41 */
42 public String parameterName() default "";
43 }