Package org.kuali.rice.location.framework.country

Class AbstractCountryValuesFinderBase

java.lang.Object
org.kuali.rice.krad.keyvalues.KeyValuesBase
org.kuali.rice.location.framework.country.AbstractCountryValuesFinderBase
All Implemented Interfaces:
Serializable, org.kuali.rice.krad.keyvalues.KeyValuesFinder
Direct Known Subclasses:
CountryNotRestrictedValuesFinder, CountryValuesFinder
public abstract class AbstractCountryValuesFinderBase extends org.kuali.rice.krad.keyvalues.KeyValuesBase
An abstract KeyValuesBase for defining a values finder which produces a list of Countries. Sub-classes should extend this class and override retrieveCountriesForValuesFinder() in order to produce a list of countries to include.
Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:

  • Constructor Details

    • AbstractCountryValuesFinderBase

      public AbstractCountryValuesFinderBase()

  • Method Details

    • getKeyValues

      public List<org.kuali.rice.core.api.util.KeyValue> getKeyValues()

    • retrieveCountriesForValuesFinder

      protected abstract List<org.kuali.rice.location.api.country.Country> retrieveCountriesForValuesFinder()
      Returns a list of countries that will be added to the result of getKeyValues(). Note that the result may be filtered by active status
      Returns:
      a List of countries to include in the values returned by this finder

    • getDefaultCountry

      protected org.kuali.rice.location.api.country.Country getDefaultCountry()
      Returns the default country to use for this values finder. If no default country is returned, none will be used. The default implementation of this method will defer to CountryService.getDefaultCountry().
      Returns:
      the default country to use for this values finder, or null if no default country should be used