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

All Superinterfaces:

Coded, Inactivatable, Versioned

All Known Implementing Classes:

Country, Country.Builder

public interface CountryContract
extends Versioned, Inactivatable, Coded

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

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

String	getAlternateCode() An alternative country code to represent a country.
String	getCode() The code value for this object.
String	getName() A full, familiar, name of a country.
boolean	isRestricted() Value representing whether a country is restricted.

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Method Detail

getCode

String getCode()

The code value for this object. In general a code value cannot be null or a blank string. 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.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

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.

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.