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, Inactivatable, Coded, Versioned, ModelObjectBasic, ModelObjectComplete, PostalCodeContract

public final class PostalCode
extends 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

static class	PostalCode.Builder This builder constructs a PostalCode enforcing the constraints of the PostalCodeContract.
static class	PostalCode.Cache

Method Summary

String	getCityName() This the postal state code for the PostalCode.
String	getCode() The code value for this object.
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() Returns the version number for this object.
boolean	isActive() The active indicator for an object.

Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getCode

public String getCode()

The code value for this object. In general a code value cannot be null or a blank string.

Specified by:

getCode in interface Coded

Returns:

the code value for this object.

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()

The active indicator for an object.

Specified by:

isActive in interface Inactivatable

Returns:

true if active false if not.

getVersionNumber

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

Returns:

the version number, or null if one has not been assigned yet