| Name | County | |
|---|---|---|
| Version | ||
| Included Services | ||
| Java Package | org.kuali.rice.location.api.county | |
CountyService interface.
| Method | getCounty | ||
|---|---|---|---|
| Description | Gets a {@link County} from a postal country code and postal code value.
|
||
| Parameters | String | countryCode | country code. cannot be blank. |
| String | stateCode | postal state code. cannot be blank. | |
| String | code | county code. cannot be blank | |
| Return | County | a {@link County} or null | |
| Errors | RiceIllegalArgumentException | country code, postal state code, or county code is blank | |
| Method | findAllCountiesInCountryAndState | ||
|---|---|---|---|
| Description | Gets all the {@link County County} for postal country code & postal state code.
|
||
| Parameters | String | countryCode | state code. cannot be blank. |
| String | stateCode | postal state code. cannot be blank. | |
| Return | CountyList | an immutable collection of counties | |
| Errors | RiceIllegalArgumentException | country code, postal state code is blank | |
| Method | findCounties | ||
|---|---|---|---|
| Description | This method find Counties based on a query criteria. The criteria cannot be null. | ||
| Parameters | QueryByCriteria | queryByCriteria | the criteria. Cannot be null. |
| Return | CountyQueryResults | query results. will never return null. | |
| Errors | RiceIllegalArgumentException | ??? | |