Package org.kuali.rice.location.api.postalcode

Class PostalCode

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.location.api.postalcode.PostalCode

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, PostalCodeContract

public final class PostalCode
extends org.kuali.rice.core.api.mo.AbstractDataTransferObject
implements PostalCodeContract

An immutable representation of a PostalCodeContract.

To construct an instance of a PostalCode, use the PostalCode.Builder class.

Author:

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

See Also:

• PostalCodeContract
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PostalCode.Builder	This builder constructs a PostalCode enforcing the constraints of the PostalCodeContract.
static class	PostalCode.Cache

Method Summary

Modifier and Type	Method	Description
String	getCityName()	This the postal state code for the PostalCode.
String	getCode()
String	getCountryCode()	This the postal country code for the PostalCode.
String	getCountyCode()	This the county code for the PostalCode.
String	getStateCode()	This the postal state code for the PostalCode.
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

getCityName

public String getCityName()

This the postal state code for the PostalCode. This can be null.

Specified by:

getCityName in interface PostalCodeContract

Returns:

postal state code

getCountryCode

public String getCountryCode()

This the postal country code for the PostalCode. This cannot be null or a blank string.

Specified by:

getCountryCode in interface PostalCodeContract

Returns:

postal country code

getStateCode

public String getStateCode()

This the postal state code for the PostalCode. This can be null.

Specified by:

getStateCode in interface PostalCodeContract

Returns:

postal state code

getCountyCode

public String getCountyCode()

This the county code for the PostalCode. This cannot be null.

Specified by:

getCountyCode in interface PostalCodeContract

Returns:

postal state 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