Package org.kuali.rice.krad.uif.control

Interface UifKeyValuesFinder

All Superinterfaces:
org.kuali.rice.krad.keyvalues.KeyValuesFinder
All Known Implementing Classes:
AdHocActionRequestCodesValuesFinder, UifKeyValuesFinderBase
public interface UifKeyValuesFinder extends org.kuali.rice.krad.keyvalues.KeyValuesFinder
Values finder that can taken the ViewModel that provides data to the view for conditionally setting the valid options

Values finder also allows configuration for a blank option that will be added by the framework

Author:
Kuali Rice Team (rice.collab@kuali.org)

  • Method Summary

    Modifier and Type
    Method
    Description
    List<org.kuali.rice.core.api.util.KeyValue>
    getKeyValues(ViewModel model)
    Builds a list of key values representations for valid value selections using the given view model to retrieve values from other fields and conditionally building the options
    List<org.kuali.rice.core.api.util.KeyValue>
    getKeyValues(ViewModel model, InputField field)
    Builds a list of key values representations for valid value selections using the given view model to retrieve values from other fields and conditionally building the options
    boolean
    isAddBlankOption()
    Indicates whether a blank option should be included as a valid option

    Methods inherited from interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

    clearInternalCache, getKeyLabel, getKeyLabelMap, getKeyValues, getKeyValues

  • Method Details

    • getKeyValues

      List<org.kuali.rice.core.api.util.KeyValue> getKeyValues(ViewModel model)
      Builds a list of key values representations for valid value selections using the given view model to retrieve values from other fields and conditionally building the options
      Parameters:
      model - object instance containing the view data
      Returns:
      List of KeyValue objects

    • getKeyValues

      List<org.kuali.rice.core.api.util.KeyValue> getKeyValues(ViewModel model, InputField field)
      Builds a list of key values representations for valid value selections using the given view model to retrieve values from other fields and conditionally building the options
      Parameters:
      model - object instance containing the view data
      field - object instance containing the field data of the key value lookup
      Returns:
      List of KeyValue objects

    • isAddBlankOption

      boolean isAddBlankOption()
      Indicates whether a blank option should be included as a valid option
      Returns:
      boolean true if the blank option should be given, false if not