CountryService

• getCountry
• getCountryByAlternateCode
• findAllCountriesNotRestricted
• findAllCountries
• getDefaultCountry
• findCountries

• Country
• CountryQueryResults
• QueryByCriteria

Method	getCountry
Description	Lookup a country object based on the given country code.
Parameters	String	code	the given country code
Return	Country		a country object with the given country code. A null reference is returned if an invalid or non-existant code is supplied.
Errors	RiceIllegalArgumentException		if the code is blank or null

Back to Operations

Method	getCountryByAlternateCode
Description	Get a country object based on an alternate country code
Parameters	String	alternateCode	the given alternate country code
Return	Country		A country object with the given alternate country code if a country with that alternate country code exists. Otherwise, null is returned.
Errors	RiceIllegalStateException		if multiple Countries exist with the same passed in alternateCode
	RiceIllegalArgumentException		if alternateCode is null or is a whitespace only string.

Back to Operations

Method	findAllCountriesNotRestricted
Description	Returns all Countries that are not restricted.
Parameters	None	None	No Parameters
Return	CountryList		all countries that are not restricted
Errors	NONE		No Errors

Back to Operations

Method	findAllCountries
Description	Returns all Countries
Parameters	None	None	No Parameters
Return	CountryList		all countries
Errors	NONE		No Errors

Back to Operations

Method	getDefaultCountry
Description	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.
Parameters	None	None	No Parameters
Return	Country		the default country, or null if no default country is defined
Errors	NONE		No Errors

Back to Operations

Method	findCountries
Description	This method find Countries based on a query criteria. The criteria cannot be null.
Parameters	QueryByCriteria	queryByCriteria	the criteria. Cannot be null.
Return	CountryQueryResults		query results. will never return null.
Errors	RiceIllegalArgumentException		???

Back to Operations