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.control;
17
18 /**
19 * Indicates <code>Control</code> types that can be configured with a static value to submit, as opposed to pulling
20 * the value from the underlying property
21 *
22 * <p>
23 * Examples of this are {@link CheckboxControl}, which can be configured with a value that will be submitted when the
24 * checkbox is checked. For example, suppose we had a model property of type Set<String> that represents selected car
25 * types. In the UI, we can present a list of available car types with a checkbox next to each. The value for the
26 * each checkbox will be the model type of the associated role: 'Ford', 'GM', 'Honda'. For each checkbox selected the
27 * associated value will be submitted and populated into the Set<String> on the model.
28 * </p>
29 *
30 * @author Kuali Rice Team (rice.collab@kuali.org)
31 */
32 public interface ValueConfiguredControl {
33
34 /**
35 * Retrieves the value that will be submitted with the control
36 *
37 * @return String control value
38 */
39 public String getValue();
40
41 /**
42 * Setter for the value that should be submitted with the control
43 *
44 * @param value
45 */
46 public void setValue(String value);
47 }