Package org.kuali.rice.location.api.state

Class State

java.lang.Object
org.kuali.rice.core.api.mo.AbstractDataTransferObject
org.kuali.rice.location.api.state.State
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, StateContract
public final class State extends org.kuali.rice.core.api.mo.AbstractDataTransferObject implements StateContract
POJO implementation of StateContract that is immutable. Instances of State 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 
    State.Builder
    This builder constructs a State enforcing the constraints of the StateContract.
    static class 
    State.Cache
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCode()
    String
    getCountryCode()
    This the postal country code for the State.
    String
    getName()
    This the postal name for the State.
    String
    getNameV3()
    The name of the state according to StateCodeDataTypeV3 in UniversalCodes-V2.0.xsd
    Long
    getVersionNumber()
    boolean
    isActive()

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

    • getName

      public String getName()
      This the postal name for the State. This cannot be null or a blank string.
      Specified by:
      getName in interface StateContract
      Returns:
      postal name

    • getNameV3

      public String getNameV3()
      The name of the state according to StateCodeDataTypeV3 in UniversalCodes-V2.0.xsd
      Specified by:
      getNameV3 in interface StateContract
      Returns:
      V3 postal name

    • getCountryCode

      public String getCountryCode()
      This the postal country code for the State. This cannot be null or a blank string.
      Specified by:
      getCountryCode in interface StateContract
      Returns:
      postal country code

    • isActive

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

    • getVersionNumber

      public Long getVersionNumber()
      Specified by:
      getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned