PostalCodeService

Name PostalCode
Version
Included Services  
Java Package org.kuali.rice.location.api.postalcode

Service for interacting with {@link PostalCode PostalCodes}.

Operations
Main Message Structures

Method getPostalCode
Description Gets a {@link PostalCode} 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 postal codes.

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

Back to Operations

Method findAllPostalCodesInCountry
Description Gets all the {@link PostalCode PostalCode} for postal country code.


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




This method will only return active postal codes.

Parameters String countryCode state code. cannot be blank.
Return PostalCodeList an immutable collection of states
Errors RiceIllegalArgumentException country code is blank

Back to Operations

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 ???

Back to Operations