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

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

StateContract, Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Methods

Modifier and Type	Method and Description
String	getCode() The code value for this object.
String	getCountryCode() This the postal country code for the State.
String	getName() This the postal name for the State.
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 postal name for the State. This cannot be null or a blank string.

Specified by:

getName in interface StateContract

Returns:

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

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