org.kuali.rice.kim.api.identity.address
Class EntityAddress.Builder

java.lang.Object
  org.kuali.rice.kim.api.identity.address.EntityAddress.Builder

All Implemented Interfaces:

Serializable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Defaultable, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Identifiable, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelBuilder, EntityAddressContract

Enclosing class:

EntityAddress

public static final class EntityAddress.Builder
extends Object
implements Serializable, org.kuali.rice.core.api.mo.ModelBuilder, EntityAddressContract

A builder which can be used to construct EntityAddress instances. Enforces the constraints of the EntityAddressContract.

See Also:

Serialized Form

Method Summary

EntityAddress	build()
static EntityAddress.Builder	create()
static EntityAddress.Builder	create(EntityAddressContract contract)
Type.Builder	getAddressType() Gets this EntityAddressContract's address type code.
String	getCityName() Gets this EntityAddressContract's city name.
String	getCityNameUnmasked() Gets this EntityAddressContract's unmasked city name.
String	getCountryCode() Gets this EntityAddressContract's country code.
String	getCountryCodeUnmasked() Gets this EntityAddressContract's unmasked country code.
String	getEntityId() Gets this id of the parent identity object.
String	getEntityTypeCode() Gets this entityTypeCode of the EntityAddressContract's object.
String	getId()
String	getLine1() Gets this EntityAddressContract's first line.
String	getLine1Unmasked() Gets this EntityAddressContract's unmasked first line.
String	getLine2() Gets this EntityAddressContract's second line.
String	getLine2Unmasked() Gets this EntityAddressContract's unmasked second line.
String	getLine3() Gets this EntityAddressContract's third line.
String	getLine3Unmasked() Gets this EntityAddressContract's unmasked third line.
String	getObjectId()
String	getPostalCode() Gets this EntityAddressContract's postal code.
String	getPostalCodeUnmasked() Gets this EntityAddressContract's unmasked postal code.
String	getStateCode() Gets this EntityAddressContract's state code.
String	getStateCodeUnmasked() Gets this EntityAddressContract's unmasked state code.
Long	getVersionNumber()
boolean	isActive()
boolean	isDefaultValue()
boolean	isSuppressAddress() Returns a boolean value that determines if address fields should be suppressed.
void	setActive(boolean active)
void	setAddressType(Type.Builder addressType)
void	setCityName(String cityName)
void	setCountryCode(String countryCode)
void	setDefaultValue(boolean defaultValue)
void	setEntityId(String entityId)
void	setEntityTypeCode(String entityTypeCode)
void	setId(String id)
void	setLine1(String line1)
void	setLine2(String line2)
void	setLine3(String line3)
void	setObjectId(String objectId)
void	setPostalCode(String postalCode)
void	setStateCode(String stateCode)
void	setVersionNumber(Long versionNumber)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static EntityAddress.Builder create()

create

public static EntityAddress.Builder create(EntityAddressContract contract)

build

public EntityAddress build()

Specified by:

build in interface org.kuali.rice.core.api.mo.ModelBuilder

getEntityId

public String getEntityId()

Description copied from interface: EntityAddressContract

Gets this id of the parent identity object.

Specified by:

getEntityId in interface EntityAddressContract

Returns:

the identity id for this EntityAddressContract

getEntityTypeCode

public String getEntityTypeCode()

Description copied from interface: EntityAddressContract

Gets this entityTypeCode of the EntityAddressContract's object.

Specified by:

getEntityTypeCode in interface EntityAddressContract

Returns:

the identity type code for this EntityAddressContract

getAddressType

public Type.Builder getAddressType()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's address type code.

Specified by:

getAddressType in interface EntityAddressContract

Returns:

the address type for this EntityAddressContract, or null if none has been assigned.

getLine1

public String getLine1()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's first line.

Specified by:

getLine1 in interface EntityAddressContract

Returns:

the first line for this EntityAddressContract, or null if none has been assigned.

getLine2

public String getLine2()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's second line.

Specified by:

getLine2 in interface EntityAddressContract

Returns:

the second line for this EntityAddressContract, or null if none has been assigned.

getLine3

public String getLine3()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's third line.

Specified by:

getLine3 in interface EntityAddressContract

Returns:

the third line for this EntityAddressContract, or null if none has been assigned.

getCityName

public String getCityName()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's city name.

Specified by:

getCityName in interface EntityAddressContract

Returns:

the city name for this EntityAddressContract, or null if none has been assigned.

getStateCode

public String getStateCode()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's state code.

Specified by:

getStateCode in interface EntityAddressContract

Returns:

the state code for this EntityAddressContract, or null if none has been assigned.

getPostalCode

public String getPostalCode()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's postal code.

Specified by:

getPostalCode in interface EntityAddressContract

Returns:

the postal code for this EntityAddressContract, or null if none has been assigned.

getCountryCode

public String getCountryCode()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's country code.

Specified by:

getCountryCode in interface EntityAddressContract

Returns:

the country code for this EntityAddressContract, or null if none has been assigned.

getLine1Unmasked

public String getLine1Unmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked first line.

Specified by:

getLine1Unmasked in interface EntityAddressContract

Returns:

the unmasked first line for this EntityAddressContract, or null if none has been assigned.

getLine2Unmasked

public String getLine2Unmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked second line.

Specified by:

getLine2Unmasked in interface EntityAddressContract

Returns:

the unmasked second line for this EntityAddressContract, or null if none has been assigned.

getLine3Unmasked

public String getLine3Unmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked third line.

Specified by:

getLine3Unmasked in interface EntityAddressContract

Returns:

the unmasked third line for this EntityAddressContract, or null if none has been assigned.

getCityNameUnmasked

public String getCityNameUnmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked city name.

Specified by:

getCityNameUnmasked in interface EntityAddressContract

Returns:

the unmasked city name for this EntityAddressContract, or null if none has been assigned.

getStateCodeUnmasked

public String getStateCodeUnmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked state code.

Specified by:

getStateCodeUnmasked in interface EntityAddressContract

Returns:

the unmasked state code for this EntityAddressContract, or null if none has been assigned.

getPostalCodeUnmasked

public String getPostalCodeUnmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked postal code.

Specified by:

getPostalCodeUnmasked in interface EntityAddressContract

Returns:

the unmasked postal code for this EntityAddressContract, or null if none has been assigned.

getCountryCodeUnmasked

public String getCountryCodeUnmasked()

Description copied from interface: EntityAddressContract

Gets this EntityAddressContract's unmasked country code.

Specified by:

getCountryCodeUnmasked in interface EntityAddressContract

Returns:

the unmasked country code for this EntityAddressContract, or null if none has been assigned.

isSuppressAddress

public boolean isSuppressAddress()

Description copied from interface: EntityAddressContract

Returns a boolean value that determines if address fields should be suppressed.

Specified by:

isSuppressAddress in interface EntityAddressContract

Returns:

boolean value that determines if address should be suppressed.

isDefaultValue

public boolean isDefaultValue()

Specified by:

isDefaultValue in interface org.kuali.rice.core.api.mo.common.Defaultable

getVersionNumber

public Long getVersionNumber()

Specified by:

getVersionNumber in interface org.kuali.rice.core.api.mo.common.Versioned

getObjectId

public String getObjectId()

Specified by:

getObjectId in interface org.kuali.rice.core.api.mo.common.GloballyUnique

isActive

public boolean isActive()

Specified by:

isActive in interface org.kuali.rice.core.api.mo.common.active.Inactivatable

getId

public String getId()

Specified by:

getId in interface org.kuali.rice.core.api.mo.common.Identifiable

setEntityId

public void setEntityId(String entityId)

setEntityTypeCode

public void setEntityTypeCode(String entityTypeCode)

setAddressType

public void setAddressType(Type.Builder addressType)

setLine1

public void setLine1(String line1)

setLine2

public void setLine2(String line2)

setLine3

public void setLine3(String line3)

setCityName

public void setCityName(String cityName)

setStateCode

public void setStateCode(String stateCode)

setPostalCode

public void setPostalCode(String postalCode)

setCountryCode

public void setCountryCode(String countryCode)

setDefaultValue

public void setDefaultValue(boolean defaultValue)

setVersionNumber

public void setVersionNumber(Long versionNumber)

setObjectId

public void setObjectId(String objectId)

setActive

public void setActive(boolean active)

setId

public void setId(String id)