org.kuali.rice.location.api.country
Class Country

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.location.api.country.Country

All Implemented Interfaces:

Serializable, Inactivatable, Coded, Versioned, ModelObjectBasic, ModelObjectComplete, CountryContract

public final class Country
extends AbstractDataTransferObject
implements CountryContract

POJO implementation of CountryContract that is immutable. Instances of Country can be (un)marshalled to and from XML.

Author:

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

See Also:

CountryContract, Serialized Form

Nested Class Summary

static class	Country.Builder Builder for immutable Country objects.
static class	Country.Cache

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.
Long	getVersionNumber() Returns the version number for this object.
boolean	isActive() The active indicator for an object.
boolean	isRestricted() Value representing whether a country is restricted.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCode

public 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

Specified by:

getCode in interface CountryContract

Returns:

the code value for this object.

getAlternateCode

public 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

Specified by:

getAlternateCode in interface CountryContract

Returns:

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

getName

public String getName()

A full, familiar, name of a country.

This property is optional

Specified by:

getName in interface CountryContract

Returns:

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

isActive

public boolean isActive()

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

isRestricted

public 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.

Specified by:

isRestricted in interface CountryContract

Returns:

if a country is restricted.

getVersionNumber

public Long getVersionNumber()

Returns the version number for this object. In general, this value should only be null if the object has not yet been stored to a persistent data store. This version number is generally used for the purposes of optimistic locking.

Specified by:

getVersionNumber in interface Versioned

Returns:

the version number, or null if one has not been assigned yet