Package org.kuali.rice.location.api.county

Interface CountyService

public interface CountyService

CountyService interface.

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

  • Method Details

    • getCounty

      @Cacheable(value="http://rice.kuali.org/location/v2_0/CountyType", key="\'countryCode=\' + #p0 + \'|\' + \'stateCode=\' + #p1 + \'|\' + \'code=\' + #p3") County getCounty(String countryCode, String stateCode, String code) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Gets a County from a postal country code and postal code value.

      This method will return null if the state does not exist.

      This method will return active or inactive counties.

      Parameters:
      countryCode - country code. cannot be blank.
      stateCode - postal state code. cannot be blank.
      code - county code. cannot be blank
      Returns:
      a County or null
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - country code, postal state code, or county code is blank

    • findAllCountiesInCountryAndState

      @Cacheable(value="http://rice.kuali.org/location/v2_0/CountyType", key="\'countryCode=\' + #p0 + \'|\' + \'stateCode=\' + #p1") List<County> findAllCountiesInCountryAndState(String countryCode, String stateCode) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Gets all the County for postal country code invalid input: '&' postal state code.

      This method will always return an immutable Collection even when no values exist.

      This method will only return active counties.

      Parameters:
      countryCode - state code. cannot be blank.
      stateCode - postal state code. cannot be blank.
      Returns:
      an immutable collection of counties
      Throws:
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException - country code, postal state code is blank

    • findCounties

      CountyQueryResults findCounties(org.kuali.rice.core.api.criteria.QueryByCriteria queryByCriteria) throws org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      This method find Counties based on a query criteria. The criteria cannot be null.
      Parameters:
      queryByCriteria - the criteria. Cannot be null.
      Returns:
      query results. will never return null.
      Throws:
      IllegalArgumentException - if the queryByCriteria is null
      org.kuali.rice.core.api.exception.RiceIllegalArgumentException
      Since:
      2.0.1