Package org.kuali.rice.kim.api.identity.address

Interface EntityAddressContract

All Superinterfaces:

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.active.Inactivatable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

EntityAddress, EntityAddress.Builder

public interface EntityAddressContract
extends org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Defaultable, org.kuali.rice.core.api.mo.common.active.Inactivatable, org.kuali.rice.core.api.mo.common.Identifiable

address information for a KIM identity

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Modifier and Type	Method	Description
String	getAddressFormat()	Returns the EntityAddressContract's address format Corresponds to PESC AddressFormat
CodedAttributeContract	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	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	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
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 interface org.kuali.rice.core.api.mo.common.Defaultable

isDefaultValue

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Methods inherited from interface org.kuali.rice.core.api.mo.common.Identifiable

getId

Methods inherited from interface org.kuali.rice.core.api.mo.common.active.Inactivatable

isActive

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Method Details

getEntityId

String getEntityId()

Gets this id of the parent identity object.

Returns:

the identity id for this EntityAddressContract

getEntityTypeCode

String getEntityTypeCode()

Gets this entityTypeCode of the EntityAddressContract's object.

Returns:

the identity type code for this EntityAddressContract

getAddressType

CodedAttributeContract getAddressType()

Gets this EntityAddressContract's address type code.

Returns:

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

getAttentionLine

String getAttentionLine()

Returns the attention line for this EntityAddressContract Corresponds to PESC AttentionLine

Returns:

the attention line

getLine1

String getLine1()

Gets this EntityAddressContract's first line.

Returns:

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

getLine2

String getLine2()

Gets this EntityAddressContract's second line.

Returns:

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

getLine3

String getLine3()

Gets this EntityAddressContract's third line.

Returns:

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

getCity

String getCity()

Gets this EntityAddressContract's city name. Corresponds to PESC City.

Returns:

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

getStateProvinceCode

String getStateProvinceCode()

Gets this EntityAddressContract's state code. Corresponds to PESC StateProvinceCode.

Returns:

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

getPostalCode

String getPostalCode()

Gets this EntityAddressContract's postal code.

Returns:

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

getCountryCode

String getCountryCode()

Gets this EntityAddressContract's country code.

Returns:

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

getAttentionLineUnmasked

String getAttentionLineUnmasked()

Returns the unmasked attention line for this EntityAddressContract

Returns:

the unmasked attention line

getLine1Unmasked

String getLine1Unmasked()

Gets this EntityAddressContract's unmasked first line.

Returns:

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

getLine2Unmasked

String getLine2Unmasked()

Gets this EntityAddressContract's unmasked second line.

Returns:

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

getLine3Unmasked

String getLine3Unmasked()

Gets this EntityAddressContract's unmasked third line.

Returns:

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

getCityUnmasked

String getCityUnmasked()

Gets this EntityAddressContract's unmasked city name.

Returns:

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

getStateProvinceCodeUnmasked

String getStateProvinceCodeUnmasked()

Gets this EntityAddressContract's unmasked state code.

Returns:

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

getPostalCodeUnmasked

String getPostalCodeUnmasked()

Gets this EntityAddressContract's unmasked postal code.

Returns:

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

getCountryCodeUnmasked

String getCountryCodeUnmasked()

Gets this EntityAddressContract's unmasked country code.

Returns:

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

getAddressFormat

String getAddressFormat()

Returns the EntityAddressContract's address format Corresponds to PESC AddressFormat

Returns:

the address format or null if none is set

getModifiedDate

org.joda.time.DateTime getModifiedDate()

Returns the EntityAddressContract's modification date Corresponds to PESC ModifiedDate

Returns:

the modification date

getValidatedDate

org.joda.time.DateTime getValidatedDate()

Returns the EntityAddressContract's validation date Corresponds to PESC ValidatedDate

Returns:

the validation date or null if none is set

isValidated

boolean isValidated()

Returns whether the EntityAddressContract is validated Corresponds to PESC Validated

Returns:

whether the address is validated

getNoteMessage

String getNoteMessage()

Returns the EntityAddressContract's note/message Corresponds to PESC NoteMessage

Returns:

the note/message or null if none is set

isSuppressAddress

boolean isSuppressAddress()

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

Returns:

boolean value that determines if address should be suppressed.