public interface Address
Modifier and Type | Interface and Description |
---|---|
static class |
Address.Field
The fields that represent the address object in json form.
|
Modifier and Type | Method and Description |
---|---|
String |
getCountry()
Get the country.
|
String |
getFormatted()
Get the formatted address.
|
Float |
getLatitude()
Get the latitude.
|
String |
getLocality()
Get the locality.
|
Float |
getLongitude()
Get the longitude of the address in degrees.
|
String |
getPostalCode()
Get the Postal code for the address.
|
Boolean |
getPrimary()
Get a Boolean value indicating whether this instance of the Plural Field is the primary or
preferred value of for this field, e.g.
|
String |
getRegion()
Get the region.
|
String |
getStreetAddress()
Get the street address.
|
String |
getType()
Get the type of label of the address.
|
void |
setCountry(String country)
Set the country.
|
void |
setFormatted(String formatted)
Set the formatted address.
|
void |
setLatitude(Float latitude)
Set the latitude.
|
void |
setLocality(String locality)
Set the locality.
|
void |
setLongitude(Float longitude)
Set the longitude of the address in degrees.
|
void |
setPostalCode(String postalCode)
Set the postal code for the address.
|
void |
setPrimary(Boolean primary) |
void |
setRegion(String region)
Set the region.
|
void |
setStreetAddress(String streetAddress)
Set the street address.
|
void |
setType(String type)
Get the type of label of the address.
|
String getCountry()
void setCountry(String country)
country
- the countryFloat getLatitude()
void setLatitude(Float latitude)
latitude
- latitudeString getLocality()
void setLocality(String locality)
locality
- the localityFloat getLongitude()
void setLongitude(Float longitude)
longitude
- the longitude of the address in degrees.String getPostalCode()
void setPostalCode(String postalCode)
postalCode
- the postal codeString getRegion()
void setRegion(String region)
region
- the regionString getStreetAddress()
void setStreetAddress(String streetAddress)
streetAddress
- the street addressString getType()
void setType(String type)
type
- the type of label of the address.String getFormatted()
void setFormatted(String formatted)
formatted
- the formatted addressBoolean getPrimary()
Get a Boolean value indicating whether this instance of the Plural Field is the primary or preferred value of for this field, e.g. the preferred mailing address. Service Providers MUST NOT mark more than one instance of the same Plural Field as primary="true", and MAY choose not to mark any fields as primary, if this information is not available. Introduced in v0.8.1
The service provider may wish to share the address instance between items and primary related to the address from which this came, so if the address came from an Organization, primary relates to the primary address of the organization, and not necessary the primary address of all addresses.
If the address is not part of a list (eg Person.location ) primary has no meaning.
void setPrimary(Boolean primary)
primary
- set the Primary status of this Address.Copyright © 2024 WSO2. All rights reserved.