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 import org.kuali.rice.krad.keyvalues.KeyValuesFinder;
20 import org.kuali.rice.krad.uif.view.ViewModel;
21
22 import java.util.List;
23
24 /**
25 * Values finder that can taken the {@link org.kuali.rice.krad.uif.view.ViewModel} that provides data to the view
26 * for conditionally setting the valid options
27 *
28 * <p>
29 * Values finder also allows configuration for a blank option that will be added by the framework
30 * </p>
31 *
32 * @author Kuali Rice Team (rice.collab@kuali.org)
33 */
34 public interface UifKeyValuesFinder extends KeyValuesFinder {
35
36 /**
37 * Builds a list of key values representations for valid value selections using the given view model
38 * to retrieve values from other fields and conditionally building the options
39 *
40 * @return List of KeyValue objects
41 */
42 public List<KeyValue> getKeyValues(ViewModel model);
43
44 /**
45 * Indicates whether a blank option should be included as a valid option
46 *
47 * @return boolean true if the blank option should be given, false if not
48 */
49 public boolean isAddBlankOption();
50 }