com.zion.jbuddy.lcs
Interface IAddressBookContact

public interface IAddressBookContact

Represents a contact entry in an Address Book.

Since:

6.3

Method Summary

String	getID() Returns the contact's unique ID.
Map	getProperties() Returns a map of all property names and values (strings).
String	getProperty(String name) Returns the specified property's value.

Method Detail

getID

String getID()

Returns the contact's unique ID.

getProperty

String getProperty(String name)

Returns the specified property's value.

Parameters:

name - The property's name. Names are case-insensitive (for example, userName and USERNAME are both valid).

The following names are accepted:

userName

Returns the contact's user name (or SIP address). This value is guaranteed to be set.

givenName

Returns the contact's given name. This is also known as the "first name" in english locales. This value is guaranteed to be set.

surname

Returns the contact's surname. This is also known as the "last name" in english locales. This value is guaranteed to be set.

displayName

Returns the contact's display name. This is in the form "GIVENNAME SURNAME" by default, but can be changed by the user.

title

Returns the contact's title, or position within the company.

companyName

Returns the name of the contact's company.

mailAddress

Returns the contact's email address, in the form "USER@HOST".

mailDisplayName

Returns the contact's email account name, which may be in the form "GIVENNAME SURNAME".

homePhone

Returns the contact's home telephone number.

workPhone

Returns the contact's work telephone number.

mobilePhone

Returns the contact's mobile telephone number.

ipPhone

Returns the contact's IP telephone number.

alternatePhone

Returns the contact's alternate telephone number.

Returns:

The property's value. If the value is not set, an empty string ("") is returned. The value is guaranteed to be non-null.

getProperties

Map getProperties()

Returns a map of all property names and values (strings).

This returns a copy of the current property map, and not the map itself.

Returns:

a map of all property names and values