org.kuali.rice.shareddata.api.country
Interface CountryContract

All Known Implementing Classes:

Country, Country.Builder

public interface CountryContract

Contract for a Country. Country is a basic abstraction over a Country, encapsulating its name, country code, postal code, and if its restricted or not

Method Summary

String	getAlternateCode() An alternative country code to represent a country.
String	getCode() An abbreviated String representing the unique identifying code for a given country.
String	getName() A full, familiar, name of a country.
Long	getVersionNumber() This the object version number for Country.
boolean	isActive() Value representing whether or not a country is active or not.
boolean	isRestricted() Value representing whether a country is restricted.

Method Detail

getCode

String getCode()

An abbreviated String representing the unique identifying code for a given country. This code correlates directly to the alpha-2 country codes from the ISO-3166-1-alpha-2 standard.

This property is required to exist.

Returns:

The country code for this Country.

getAlternateCode

String getAlternateCode()

An alternative country code to represent a country. This code correlats directly to the alpha-3 codes from the ISO_3166-1-alpha-3 standard.

This property is optional

Returns:

The alternate country code if it exists. null is returned if an alternate code does not exist.

getName

String getName()

A full, familiar, name of a country.

This property is optional

Returns:

The name of a country if it exists. null is returned if a full name does not exist.

isActive

boolean isActive()

Value representing whether or not a country is active or not.

Returns:

if a country is active

See Also:

org.kuali.rice.kns.bo.Inactivateable

isRestricted

boolean isRestricted()

Value representing whether a country is restricted.

The meaning of restricted for a country varies depending upon the implementer - for instance if a country may not be used in the address of a Vendor.

The default value of this property is false.

Returns:

if a country is restricted.

getVersionNumber

Long getVersionNumber()

This the object version number for Country.

Returns:

the version number of the Country