001    /*
002     * Copyright 2007 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 1.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/ecl1.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     */
016    package org.kuali.rice.krad.uif.control;
017    
018    import org.kuali.rice.core.api.util.KeyValue;
019    
020    import java.util.List;
021    
022    /**
023     * Base class for controls that accept/display multiple values
024     * 
025     * @author Kuali Rice Team (rice.collab@kuali.org)
026     */
027    public abstract class MultiValueControlBase extends ControlBase {
028            private static final long serialVersionUID = -8691367056245775455L;
029    
030            private List<KeyValue> options;
031    
032            public MultiValueControlBase() {
033                    super();
034            }
035    
036            /**
037             * <code>List</code> of values the control can accept. Each value consists
038             * of a key and a label. The key is the what will be submitted back if the
039             * user selects the choice, the label is what will be displayed to the user
040             * for the choice.
041             * <p>
042             * <code>KeyLabelPair</code> instances are usually generated by the
043             * <code>KeyValueFinder</code> associated with the <code>Field</code> for
044             * which the control belongs
045             * </p>
046             * 
047             * @return List of KeyLabelPair instances
048             */
049            public List<KeyValue> getOptions() {
050                    return this.options;
051            }
052    
053            public void setOptions(List<KeyValue> options) {
054                    this.options = options;
055            }
056    
057    }