org.glassfish.cafe.api.presence
Interface CivicLocationInfo

public interface CivicLocationInfo

The CivicLocationInfo component models the civic location for a person or a device. The CivicLocationInfo and ImsGeographicalLocationInfo interfaces together form an implementation of the GEOPRIV Location Object Format specified in [RFC4119].

Field Summary

static String	ADDITIONAL_LOCATION_INFO
static String	CITY
static String	CITY_DIVISION
static String	COUNTRY_CODE
static String	COUNTY
static String	FLOOR
static String	HOUSE_NUMBER
static String	HOUSE_NUMBER_SUFFIX
static String	LANDMARK
static String	LEADING_STREET_DIRECTION
static String	NATIONAL_SUBDIVISION
static String	NEIGHBORHOOD
static String	POSTAL_CODE
static String	RESIDENCE
static String	STREET
static String	STREET_SUFFIX
static String	TRAILING_STREET_SUFFIX

Method Summary

void	addCivicAddress(String identifier, String value) Adds a civic address element.
String	getCivicAddress(String identifier) Returns the value of the civic address identifier.
void	removeCivicAddress(String identifier) Removes the civic address element with the given identifier.

Field Detail

COUNTRY_CODE

static final String COUNTRY_CODE

See Also:

Constant Field Values

NATIONAL_SUBDIVISION

static final String NATIONAL_SUBDIVISION

See Also:

Constant Field Values

COUNTY

static final String COUNTY

See Also:

Constant Field Values

CITY

static final String CITY

See Also:

Constant Field Values

CITY_DIVISION

static final String CITY_DIVISION

See Also:

Constant Field Values

NEIGHBORHOOD

static final String NEIGHBORHOOD

See Also:

Constant Field Values

STREET

static final String STREET

See Also:

Constant Field Values

LEADING_STREET_DIRECTION

static final String LEADING_STREET_DIRECTION

See Also:

Constant Field Values

TRAILING_STREET_SUFFIX

static final String TRAILING_STREET_SUFFIX

See Also:

Constant Field Values

STREET_SUFFIX

static final String STREET_SUFFIX

See Also:

Constant Field Values

HOUSE_NUMBER

static final String HOUSE_NUMBER

See Also:

Constant Field Values

HOUSE_NUMBER_SUFFIX

static final String HOUSE_NUMBER_SUFFIX

See Also:

Constant Field Values

LANDMARK

static final String LANDMARK

See Also:

Constant Field Values

ADDITIONAL_LOCATION_INFO

static final String ADDITIONAL_LOCATION_INFO

See Also:

Constant Field Values

FLOOR

static final String FLOOR

See Also:

Constant Field Values

RESIDENCE

static final String RESIDENCE

See Also:

Constant Field Values

POSTAL_CODE

static final String POSTAL_CODE

See Also:

Constant Field Values

Method Detail

getCivicAddress

String getCivicAddress(String identifier)

Returns the value of the civic address identifier.

Parameters:

identifier -

Returns:

a String with the civic address identifier

addCivicAddress

void addCivicAddress(String identifier,
                     String value)

Adds a civic address element. This will replace any existing value for this identifier.

Parameters:

identifier -

value -

removeCivicAddress

void removeCivicAddress(String identifier)

Removes the civic address element with the given identifier.

Parameters:

identifier -