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

Class State.Builder

java.lang.Object

org.kuali.rice.location.api.state.State.Builder

All Implemented Interfaces:

Serializable, Inactivatable, Coded, Versioned, ModelBuilder, StateContract

Enclosing class:

State

public static class State.Builder
extends Object
implements StateContract, ModelBuilder, Serializable

This builder constructs a State enforcing the constraints of the StateContract.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
State	build()
static State.Builder	create(String code, String name, String countryCode)
static State.Builder	create(String code, String name, String nameV3, String countryCode)
static State.Builder	create(StateContract contract)	creates a Parameter from an existing StateContract.
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()
void	setActive(boolean active)
void	setCode(String code)
void	setCountryCode(String countryCode)
void	setName(String name)
void	setNameV3(String nameV3)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static State.Builder create(String code,
 String name,
 String countryCode)

create

public static State.Builder create(String code,
 String name,
 String nameV3,
 String countryCode)

create

public static State.Builder create(StateContract contract)

creates a Parameter from an existing StateContract.

getCode

public String getCode()

Specified by:

getCode in interface Coded

setCode

public void setCode(String code)

getName

public String getName()

Description copied from interface: StateContract

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

Specified by:

getName in interface StateContract

Returns:

postal name

setName

public void setName(String name)

getNameV3

public String getNameV3()

Description copied from interface: StateContract

The name of the state according to StateCodeDataTypeV3 in UniversalCodes-V2.0.xsd

Specified by:

getNameV3 in interface StateContract

Returns:

V3 postal name

setNameV3

public void setNameV3(String nameV3)

getCountryCode

public String getCountryCode()

Description copied from interface: StateContract

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

setCountryCode

public void setCountryCode(String countryCode)

isActive

public boolean isActive()

Specified by:

isActive in interface Inactivatable

setActive

public void setActive(boolean active)

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface Versioned

setVersionNumber

public void setVersionNumber(Long versionNumber)

build

public State build()

Specified by:

build in interface ModelBuilder