Package org.kuali.rice.location.api.country

Interface CountryContract

All Superinterfaces:
org.kuali.rice.core.api.mo.common.Coded, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned
All Known Implementing Classes:
Country, Country.Builder
public interface CountryContract extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.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

    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
    boolean
    isRestricted()
    Value representing whether a country is restricted.

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

    isActive

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

    getVersionNumber

  • Method Details

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

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

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

    • getNameV3

      String getNameV3()
      The name of a country according to CountryCodeDataTypeV3 in UniversalCodes-V2.0.xsd

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