Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
MultiValueControl |
|
| 1.0;1 |
1 | /** | |
2 | * Copyright 2005-2011 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 | import org.kuali.rice.core.api.util.KeyValue; | |
19 | ||
20 | import java.util.List; | |
21 | ||
22 | /** | |
23 | * Indicates <code>Control</code> types that can hold more than one value for selection | |
24 | * | |
25 | * @author Kuali Rice Team (rice.collab@kuali.org) | |
26 | */ | |
27 | public interface MultiValueControl { | |
28 | ||
29 | /** | |
30 | * <code>List</code> of values the control can accept. Each value consists | |
31 | * of a key and a label. The key is the what will be submitted back if the | |
32 | * user selects the choice, the label is what will be displayed to the user | |
33 | * for the choice. | |
34 | * <p> | |
35 | * <code>KeyLabelPair</code> instances are usually generated by the | |
36 | * <code>KeyValueFinder</code> associated with the <code>Field</code> for | |
37 | * which the control belongs | |
38 | * </p> | |
39 | * | |
40 | * @return List of KeyLabelPair instances | |
41 | */ | |
42 | public List<KeyValue> getOptions(); | |
43 | ||
44 | /** | |
45 | * Sets the List of <code>KeyValue</code> pairs that make up the options for the control | |
46 | * | |
47 | * @param options | |
48 | */ | |
49 | public void setOptions(List<KeyValue> options); | |
50 | } |