Package 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, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Coded, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.ModelObjectComplete, CountryContract
public final class Country extends org.kuali.rice.core.api.mo.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:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    Country.Builder
    Builder for immutable Country objects.
    static class 
    Country.Cache
     

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    String
    getNameV3()
    The name of a country according to CountryCodeDataTypeV3 in UniversalCodes-V2.0.xsd
    Long
    getVersionNumber()
    boolean
    isActive()
    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 Details

    • getCode

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

      Specified by:
      getCode in interface org.kuali.rice.core.api.mo.common.Coded
      Specified by:
      getCode in interface CountryContract

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

    • getNameV3

      public String getNameV3()
      The name of a country according to CountryCodeDataTypeV3 in UniversalCodes-V2.0.xsd
      Specified by:
      getNameV3 in interface CountryContract

    • isActive

      public boolean isActive()
      Specified by:
      isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

    • 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()
      Specified by:
      getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned