@AccessLevel(value=EXTERNAL)
public interface Address
extends curam.util.persistence.StandardEntity
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAddressData()
Getter for the address data xml string.
|
curam.core.struct.AddressDtls |
getAddressDetails()
Retrieves the address details.
|
curam.codetable.impl.CONCERNROLEADDRESSTYPEEntry |
getAddressType(ConcernRole concernRole)
Retrieves the type of this address .
|
java.lang.String |
getCity()
Retrieves the city entered for this address.
|
java.lang.String |
getFirstLine()
Retrieves the first line of this address.
|
java.lang.String |
getFormattedAddressData()
Gets the formatted address data - a new line delimited version of the
address i.e. addressLine 1 addressLine 2 .. .. zip code
|
java.lang.Double |
getLatitude()
Retrieves the location of this address on the earth from the north or south
of the equator.
|
curam.core.struct.OtherAddressData |
getLongFormat()
Returns formatted address line for a given address id.
|
java.lang.Double |
getLongitude()
Retrieves the location of this address on the earth from east or west of
the prime meridian.
|
java.lang.String |
getOneLineAddressString()
Retrieves a comma separated string of this address formatted for a single
line.
|
java.lang.Double |
getProximityTo(Address relatedAddress,
curam.codetable.impl.UNITOFDISTANCEEntry unitOfDistance)
Retrieves the proximity between this address and the given address.
|
java.lang.String |
getState()
Retrieves the state entered for this address.
|
java.lang.String |
getStreetAndCityDetails()
Retries the street and city details entered for this address in a comma
separated string.
|
int |
getVersionNo()
Retrieves the version number for the address in persistence.
|
java.lang.String getAddressData()
java.lang.String getFormattedAddressData() throws curam.util.exception.InformationalException, curam.util.exception.AppException
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.Double getProximityTo(Address relatedAddress, curam.codetable.impl.UNITOFDISTANCEEntry unitOfDistance)
To determine the proximity between the two addresses the HaverSine formula is used. If a geoCode, longitude or latitude do not exist for either this address or the related address null is returned
relatedAddress
- The address the proximity to this address is to be calculatedunitOfDistance
- the unit of measurement the calculated proximity is to be returned
injava.lang.Double getLongitude()
java.lang.Double getLatitude()
curam.codetable.impl.CONCERNROLEADDRESSTYPEEntry getAddressType(ConcernRole concernRole)
concernRole
- the ConcernRole
the address is related tojava.lang.String getOneLineAddressString() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getFirstLine() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getCity() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getState() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.AppException
- Generic Exception Signaturecuram.util.exception.InformationalException
- Generic Exception Signaturejava.lang.String getStreetAndCityDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.InformationalException
- Generic Exception Signaturecuram.util.exception.AppException
- Generic Exception Signatureint getVersionNo() throws curam.util.exception.AppException, curam.util.exception.InformationalException
curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) curam.core.struct.AddressDtls getAddressDetails() throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- Holds the address id.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.@AccessLevel(value=EXTERNAL) curam.core.struct.OtherAddressData getLongFormat() throws curam.util.exception.AppException, curam.util.exception.InformationalException
key
- Holds the address id.curam.util.exception.InformationalException
- Generic Exception Signature.curam.util.exception.AppException
- Generic Exception Signature.