org.kuali.rice.location.impl.country

Class CountryServiceImpl

java.lang.Object

org.kuali.rice.location.impl.country.CountryServiceImpl

All Implemented Interfaces:

CountryService

public final class CountryServiceImpl
extends Object
implements CountryService

Constructor Summary

Constructors

Constructor and Description
CountryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<Country>	findAllCountries() Returns all Countries
List<Country>	findAllCountriesNotRestricted() Returns all Countries that are not restricted.
CountryQueryResults	findCountries(QueryByCriteria queryByCriteria) This method find Countries based on a query criteria.
Country	getCountry(String code) Lookup a country object based on the given country code.
Country	getCountryByAlternateCode(String alternateCode) Get a country object based on an alternate country code
DataObjectService	getDataObjectService()
Country	getDefaultCountry() Returns the system default country.
ParameterService	getParameterService()
void	setDataObjectService(DataObjectService dataObjectService)
void	setParameterService(ParameterService parameterService)

Methods inherited from class java.lang.Object

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

Constructor Detail

CountryServiceImpl

public CountryServiceImpl()

Method Detail

getCountry

public Country getCountry(String code)

Description copied from interface: CountryService

Lookup a country object based on the given country code.

Specified by:

getCountry in interface CountryService

Parameters:

code - the given country code

Returns:

a country object with the given country code. A null reference is returned if an invalid or non-existant code is supplied.

getCountryByAlternateCode

public Country getCountryByAlternateCode(String alternateCode)

Description copied from interface: CountryService

Get a country object based on an alternate country code

Specified by:

getCountryByAlternateCode in interface CountryService

Parameters:

alternateCode - the given alternate country code

Returns:

A country object with the given alternate country code if a country with that alternate country code exists. Otherwise, null is returned.

findAllCountriesNotRestricted

public List<Country> findAllCountriesNotRestricted()

Description copied from interface: CountryService

Returns all Countries that are not restricted.

Specified by:

findAllCountriesNotRestricted in interface CountryService

Returns:

all countries that are not restricted

findAllCountries

public List<Country> findAllCountries()

Description copied from interface: CountryService

Returns all Countries

Specified by:

findAllCountries in interface CountryService

Returns:

all countries

getDefaultCountry

public Country getDefaultCountry()

Description copied from interface: CountryService

Returns the system default country. This is simply meant to be informational for applications which need the ability to utilize a default country (such as for defaulting of certain fields during data entry). This method may return null in situations where no default country is configured.

Specified by:

getDefaultCountry in interface CountryService

Returns:

the default country, or null if no default country is defined

findCountries

public CountryQueryResults findCountries(QueryByCriteria queryByCriteria)
                                  throws RiceIllegalArgumentException

Description copied from interface: CountryService

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

Specified by:

findCountries in interface CountryService

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

RiceIllegalArgumentException

getParameterService

public ParameterService getParameterService()

setParameterService

public void setParameterService(ParameterService parameterService)

getDataObjectService

public DataObjectService getDataObjectService()

setDataObjectService

public void setDataObjectService(DataObjectService dataObjectService)