org.kuali.rice.location.impl.postalcode

Class PostalCodeServiceImpl

java.lang.Object

org.kuali.rice.location.impl.postalcode.PostalCodeServiceImpl

All Implemented Interfaces:

PostalCodeService

public class PostalCodeServiceImpl
extends Object
implements PostalCodeService

Constructor Summary

Constructors

Constructor and Description
PostalCodeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<PostalCode>	findAllPostalCodesInCountry(String countryCode) Gets all the PostalCode for postal country code.
PostalCodeQueryResults	findPostalCodes(QueryByCriteria queryByCriteria) This method find PostalCodes based on a query criteria.
DataObjectService	getDataObjectService()
PostalCode	getPostalCode(String countryCode, String code) Gets a PostalCode from a postal country code and postal code value.
void	setDataObjectService(DataObjectService dataObjectService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PostalCodeServiceImpl

public PostalCodeServiceImpl()

Method Detail

getPostalCode

public PostalCode getPostalCode(String countryCode,
                       String code)

Description copied from interface: PostalCodeService

Gets a 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.

Specified by:

getPostalCode in interface PostalCodeService

Parameters:

countryCode - country code. cannot be blank.

code - postal code value. cannot be blank.

Returns:

a PostalCode or null

findAllPostalCodesInCountry

public List<PostalCode> findAllPostalCodesInCountry(String countryCode)

Description copied from interface: PostalCodeService

Gets all the 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.

Specified by:

findAllPostalCodesInCountry in interface PostalCodeService

Parameters:

countryCode - state code. cannot be blank.

Returns:

an immutable collection of states

findPostalCodes

public PostalCodeQueryResults findPostalCodes(QueryByCriteria queryByCriteria)
                                       throws RiceIllegalArgumentException

Description copied from interface: PostalCodeService

This method find PostalCodes based on a query criteria. The criteria cannot be null.

Specified by:

findPostalCodes in interface PostalCodeService

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

RiceIllegalArgumentException

getDataObjectService

public DataObjectService getDataObjectService()

setDataObjectService

public void setDataObjectService(DataObjectService dataObjectService)