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.uif.component;
017
018import java.lang.annotation.Documented;
019import java.lang.annotation.ElementType;
020import java.lang.annotation.Retention;
021import java.lang.annotation.RetentionPolicy;
022import java.lang.annotation.Target;
023
024/**
025 * Annotation for <code>View</code> fields to indicate the field can be set by a
026 * parameter of the initial request
027 *
028 * @author Kuali Rice Team (rice.collab@kuali.org)
029 */
030@Target({ ElementType.FIELD })
031@Retention(RetentionPolicy.RUNTIME)
032@Documented
033public @interface RequestParameter {
034
035        /**
036         * Name of the request parameter whose value should be pulled to populate
037         * the field. If not set, any parameter that matches the name of the field
038         * will be used
039         *
040         * @return String request parameter name
041         */
042        String parameterName() default "";
043}