| Name | PostalCode | |
|---|---|---|
| Version | ||
| Included Services | ||
| Java Package | org.kuali.rice.location.api.postalcode | |
| Method | getPostalCode | ||
|---|---|---|---|
| Description | Gets a {@link PostalCode} from a postal country code and postal code value.
|
||
| Parameters | String | countryCode | country code. cannot be blank. |
| String | code | postal code value. cannot be blank. | |
| Return | PostalCode | a {@link PostalCode} or null | |
| Errors | RiceIllegalArgumentException | country code or postal code value is blank | |
| Method | findAllPostalCodesInCountry | ||
|---|---|---|---|
| Description | Gets all the {@link PostalCode PostalCode} for postal country code.
|
||
| Parameters | String | countryCode | state code. cannot be blank. |
| Return | PostalCodeList | an immutable collection of states | |
| Errors | RiceIllegalArgumentException | country code is blank | |
| Method | findPostalCodes | ||
|---|---|---|---|
| Description | This method find PostalCodes based on a query criteria. The criteria cannot be null. | ||
| Parameters | QueryByCriteria | queryByCriteria | the criteria. Cannot be null. |
| Return | PostalCodeQueryResults | query results. will never return null. | |
| Errors | RiceIllegalArgumentException | ??? | |