EntityAddress.Builder (Rice 2.2.0-M4-SNAPSHOT API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelBuilder, EntityAddressContract

Enclosing class:: EntityAddress

public static final class EntityAddress.Builder
extends Object
implements Serializable, ModelBuilder, EntityAddressContract
extends Object
implements Serializable, 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()` Returns an instance of the object being built by this builder based on the current state of the builder.
`static EntityAddress.Builder`	`create()`
`static EntityAddress.Builder`	`create(EntityAddressContract contract)`
`String`	`getAddressFormat()` Returns the `EntityAddressContract`'s address format Corresponds to PESC AddressFormat
`CodedAttribute.Builder`	`getAddressType()` Gets this `EntityAddressContract`'s address type code.
`String`	`getAttentionLine()` Returns the attention line for this `EntityAddressContract` Corresponds to PESC AttentionLine
`String`	`getAttentionLineUnmasked()` Returns the unmasked attention line for this `EntityAddressContract`
`String`	`getCity()` Gets this `EntityAddressContract`'s city name.
`String`	`getCityUnmasked()` 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()` The unique identifier for an object.
`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.
`org.joda.time.DateTime`	`getModifiedDate()` Returns the `EntityAddressContract`'s modification date Corresponds to PESC ModifiedDate
`String`	`getNoteMessage()` Returns the `EntityAddressContract`'s note/message Corresponds to PESC NoteMessage
`String`	`getObjectId()` Return the globally unique object id of this object.
`String`	`getPostalCode()` Gets this `EntityAddressContract`'s postal code.
`String`	`getPostalCodeUnmasked()` Gets this `EntityAddressContract`'s unmasked postal code.
`String`	`getStateProvinceCode()` Gets this `EntityAddressContract`'s state code.
`String`	`getStateProvinceCodeUnmasked()` Gets this `EntityAddressContract`'s unmasked state code.
`org.joda.time.DateTime`	`getValidatedDate()` Returns the `EntityAddressContract`'s validation date Corresponds to PESC ValidatedDate
`Long`	`getVersionNumber()` Returns the version number for this object.
`boolean`	`isActive()` The active indicator for an object.
`boolean`	`isDefaultValue()` The default value for this object.
`boolean`	`isSuppressAddress()` Returns a boolean value that determines if address fields should be suppressed.
`boolean`	`isValidated()` Returns whether the `EntityAddressContract` is validated Corresponds to PESC Validated
`void`	`setActive(boolean active)`
`void`	`setAddressFormat(String addressFormat)`
`void`	`setAddressType(CodedAttribute.Builder addressType)`
`void`	`setAttentionLine(String attnLine)`
`void`	`setCity(String city)`
`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`	`setModifiedDate(org.joda.time.DateTime modifiedDate)`
`void`	`setNoteMessage(String noteMessage)`
`void`	`setObjectId(String objectId)`
`void`	`setPostalCode(String postalCode)`
`void`	`setStateProvinceCode(String stateProvinceCode)`
`void`	`setValidated(boolean validated)`
`void`	`setValidatedDate(org.joda.time.DateTime validatedDate)`
`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()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:: build in interface ModelBuilder

Returns:: an instance of the object being built by this builder, should never return null