1 /**
2 * Copyright 2005-2013 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 import org.kuali.rice.krad.uif.util.KeyMessage;
20 import org.kuali.rice.krad.uif.view.View;
21 import java.util.List;
22
23 /**
24 * Indicates <code>Control</code> types that can hold more than one value for selection
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface MultiValueControl {
29
30 /**
31 * <code>List</code> of values the control can accept. Each value consists
32 * of a key and a label. The key is the what will be submitted back if the
33 * user selects the choice, the label is what will be displayed to the user
34 * for the choice.
35 * <p>
36 * <code>KeyLabelPair</code> instances are usually generated by the
37 * <code>KeyValueFinder</code> associated with the <code>Field</code> for
38 * which the control belongs
39 * </p>
40 *
41 * @return List of KeyLabelPair instances
42 */
43 public List<KeyValue> getOptions();
44
45 /**
46 * Sets the List of <code>KeyValue</code> pairs that make up the options for the control
47 *
48 * @param options
49 */
50 public void setOptions(List<KeyValue> options);
51
52 /**
53 * Gets the richOptions which contain Message objects with the translated rich message structures, which then can
54 * be used by templates to output the appropriate content.
55 *
56 * @return richOptions which include a message object with the translated value content
57 */
58 public List<KeyMessage> getRichOptions();
59 }