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

java.lang.Object
  extended by org.kuali.rice.core.api.mo.AbstractDataTransferObject
      extended by org.kuali.rice.kim.api.identity.address.EntityAddress
All Implemented Interfaces:
Serializable, Inactivatable, Defaultable, GloballyUnique, Identifiable, Versioned, ModelObjectBasic, ModelObjectComplete, EntityAddressContract

public final class EntityAddress
extends AbstractDataTransferObject
implements EntityAddressContract

See Also:
Serialized Form

Nested Class Summary
static class EntityAddress.Builder
          A builder which can be used to construct EntityAddress instances.
 
Method Summary
 String getAddressFormat()
          Returns the EntityAddressContract's address format Corresponds to PESC AddressFormat
 CodedAttribute 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
 
Methods inherited from class org.kuali.rice.core.api.mo.AbstractDataTransferObject
afterUnmarshal, beforeUnmarshal, equals, hashCode, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

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 CodedAttribute 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.

getAttentionLine

public String getAttentionLine()
Description copied from interface: EntityAddressContract
Returns the attention line for this EntityAddressContract Corresponds to PESC AttentionLine

Specified by:
getAttentionLine in interface EntityAddressContract
Returns:
the attention line

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.

getCity

public String getCity()
Description copied from interface: EntityAddressContract
Gets this EntityAddressContract's city name. Corresponds to PESC City.

Specified by:
getCity in interface EntityAddressContract
Returns:
the city name for this EntityAddressContract, or null if none has been assigned.

getStateProvinceCode

public String getStateProvinceCode()
Description copied from interface: EntityAddressContract
Gets this EntityAddressContract's state code. Corresponds to PESC StateProvinceCode.

Specified by:
getStateProvinceCode 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.

getAttentionLineUnmasked

public String getAttentionLineUnmasked()
Description copied from interface: EntityAddressContract
Returns the unmasked attention line for this EntityAddressContract

Specified by:
getAttentionLineUnmasked in interface EntityAddressContract
Returns:
the unmasked attention line

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.

getCityUnmasked

public String getCityUnmasked()
Description copied from interface: EntityAddressContract
Gets this EntityAddressContract's unmasked city name.

Specified by:
getCityUnmasked in interface EntityAddressContract
Returns:
the unmasked city name for this EntityAddressContract, or null if none has been assigned.

getStateProvinceCodeUnmasked

public String getStateProvinceCodeUnmasked()
Description copied from interface: EntityAddressContract
Gets this EntityAddressContract's unmasked state code.

Specified by:
getStateProvinceCodeUnmasked 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.

getAddressFormat

public String getAddressFormat()
Description copied from interface: EntityAddressContract
Returns the EntityAddressContract's address format Corresponds to PESC AddressFormat

Specified by:
getAddressFormat in interface EntityAddressContract
Returns:
the address format or null if none is set

getModifiedDate

public org.joda.time.DateTime getModifiedDate()
Description copied from interface: EntityAddressContract
Returns the EntityAddressContract's modification date Corresponds to PESC ModifiedDate

Specified by:
getModifiedDate in interface EntityAddressContract
Returns:
the modification date

getValidatedDate

public org.joda.time.DateTime getValidatedDate()
Description copied from interface: EntityAddressContract
Returns the EntityAddressContract's validation date Corresponds to PESC ValidatedDate

Specified by:
getValidatedDate in interface EntityAddressContract
Returns:
the validation date or null if none is set

isValidated

public boolean isValidated()
Description copied from interface: EntityAddressContract
Returns whether the EntityAddressContract is validated Corresponds to PESC Validated

Specified by:
isValidated in interface EntityAddressContract
Returns:
whether the address is validated

getNoteMessage

public String getNoteMessage()
Description copied from interface: EntityAddressContract
Returns the EntityAddressContract's note/message Corresponds to PESC NoteMessage

Specified by:
getNoteMessage in interface EntityAddressContract
Returns:
the note/message or null if none is set

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()
Description copied from interface: Defaultable
The default value for this object.

Specified by:
isDefaultValue in interface Defaultable
Returns:
the default value for this object

getVersionNumber

public Long getVersionNumber()
Description copied from interface: Versioned
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

getObjectId

public String getObjectId()
Description copied from interface: GloballyUnique
Return the globally unique object id of this object. In general, this value should only be null if the object has not yet been stored to a persistent data store.

Specified by:
getObjectId in interface GloballyUnique
Returns:
the objectId of this object, or null if it has not been set yet

isActive

public boolean isActive()
Description copied from interface: Inactivatable
The active indicator for an object.

Specified by:
isActive in interface Inactivatable
Returns:
true if active false if not.

getId

public String getId()
Description copied from interface: Identifiable
The unique identifier for an object. This can be null.

Specified by:
getId in interface Identifiable
Returns:
the id


Copyright © 2005-2011 The Kuali Foundation. All Rights Reserved.