org.wso2.carbon.registry.social.api.people.userprofile.model
Interface Address


public interface Address

Base interface for all address objects.


Nested Class Summary
static class Address.Field
          The fields that represent the address object in json form.
 
Method Summary
 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.
 

Method Detail

getCountry

String getCountry()
Get the country.

Returns:
the country

setCountry

void setCountry(String country)
Set the country.

Parameters:
country - the country

getLatitude

Float getLatitude()
Get the latitude.

Returns:
latitude

setLatitude

void setLatitude(Float latitude)
Set the latitude.

Parameters:
latitude - latitude

getLocality

String getLocality()
Get the locality.

Returns:
the locality

setLocality

void setLocality(String locality)
Set the locality.

Parameters:
locality - the locality

getLongitude

Float getLongitude()
Get the longitude of the address in degrees.

Returns:
the longitude of the address in degrees

setLongitude

void setLongitude(Float longitude)
Set the longitude of the address in degrees.

Parameters:
longitude - the longitude of the address in degrees.

getPostalCode

String getPostalCode()
Get the Postal code for the address.

Returns:
the postal code for the address

setPostalCode

void setPostalCode(String postalCode)
Set the postal code for the address.

Parameters:
postalCode - the postal code

getRegion

String getRegion()
Get the region.

Returns:
the region

setRegion

void setRegion(String region)
Set the region.

Parameters:
region - the region

getStreetAddress

String getStreetAddress()
Get the street address.

Returns:
the street address

setStreetAddress

void setStreetAddress(String streetAddress)
Set the street address.

Parameters:
streetAddress - the street address

getType

String getType()
Get the type of label of the address.

Returns:
the type or label of the address

setType

void setType(String type)
Get the type of label of the address.

Parameters:
type - the type of label of the address.

getFormatted

String getFormatted()
Get the formatted address.

Returns:
the formatted address

setFormatted

void setFormatted(String formatted)
Set the formatted address.

Parameters:
formatted - the formatted address

getPrimary

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

Returns:
true if the instance if the primary instance.

setPrimary

void setPrimary(Boolean primary)
Parameters:
primary - set the Primary status of this Address.


Copyright © 2015 WSO2. All Rights Reserved.