1 /*
2 * Copyright 2007 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 1.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/ecl1.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 * Base class for controls that accept/display multiple values
24 *
25 * @author Kuali Rice Team (rice.collab@kuali.org)
26 */
27 public abstract class MultiValueControlBase extends ControlBase {
28 private static final long serialVersionUID = -8691367056245775455L;
29
30 private List<KeyValue> options;
31
32 public MultiValueControlBase() {
33 super();
34 }
35
36 /**
37 * <code>List</code> of values the control can accept. Each value consists
38 * of a key and a label. The key is the what will be submitted back if the
39 * user selects the choice, the label is what will be displayed to the user
40 * for the choice.
41 * <p>
42 * <code>KeyLabelPair</code> instances are usually generated by the
43 * <code>KeyValueFinder</code> associated with the <code>Field</code> for
44 * which the control belongs
45 * </p>
46 *
47 * @return List of KeyLabelPair instances
48 */
49 public List<KeyValue> getOptions() {
50 return this.options;
51 }
52
53 public void setOptions(List<KeyValue> options) {
54 this.options = options;
55 }
56
57 }