org.kuali.rice.location.api.county
Class County

java.lang.Object
  org.kuali.rice.core.api.mo.AbstractDataTransferObject
      org.kuali.rice.location.api.county.County

All Implemented Interfaces:

Serializable, Inactivatable, Coded, Versioned, ModelObjectBasic, ModelObjectComplete, CountyContract

public final class County
extends AbstractDataTransferObject
implements CountyContract

An immutable representation of a CountyContract.

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

Author:

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

See Also:

CountyContract, Serialized Form

Nested Class Summary

static class	County.Builder This builder constructs an County enforcing the constraints of the CountyContract.
static class	County.Cache

Method Summary

String	getCode() The code value for this object.
String	getCountryCode() This the postal country code for the County.
String	getName() This the name for the County.
String	getStateCode() This the postal state code for the County.
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, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, 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.

getName

public String getName()

This the name for the County. This cannot be null or a blank string.

Specified by:

getName in interface CountyContract

Returns:

name

getCountryCode

public String getCountryCode()

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

Specified by:

getCountryCode in interface CountyContract

Returns:

postal country code

getStateCode

public String getStateCode()

This the postal state code for the County. This cannot be null or a blank string.

Specified by:

getStateCode in interface CountyContract

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