Package org.kuali.rice.location.framework.country

Interface CountryEbo

All Superinterfaces:
org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.core.api.mo.common.Coded, CountryContract, org.kuali.rice.krad.bo.ExternalizableBusinessObject, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.core.api.mo.common.active.MutableInactivatable, Serializable, org.kuali.rice.core.api.mo.common.Versioned
public interface CountryEbo extends CountryContract, org.kuali.rice.krad.bo.ExternalizableBusinessObject, org.kuali.rice.core.api.mo.common.active.MutableInactivatable
TODO: Likely should remove all methods from this interface after KULRICE-7170 is fixed

  • 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 the country as found in UniversalCodes-V2.0.
    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.
    void
    setActive(boolean active)
    Sets the record to active or inactive.

    Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

    refresh

    Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

    toString

  • 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
      Specified by:
      getCode in interface CountryContract

    • 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

      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

      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

      String getNameV3()
      The name of the country as found in UniversalCodes-V2.0.

      This property is optional

      Specified by:
      getNameV3 in interface CountryContract
      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.

      Specified by:
      isRestricted in interface CountryContract
      Returns:
      if a country is restricted.

    • getVersionNumber

      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 org.kuali.rice.core.api.mo.common.Versioned
      Returns:
      the version number, or null if one has not been assigned yet

    • isActive

      boolean isActive()
      The active indicator for an object.
      Specified by:
      isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable
      Returns:
      true if active false if not.

    • setActive

      void setActive(boolean active)
      Sets the record to active or inactive.
      Specified by:
      setActive in interface org.kuali.rice.core.api.mo.common.active.MutableInactivatable