Search optimised copy of a contact that lives in an address book, holding just enough of the person's details to find them quickly. The complete record is kept as CardDAV text inside the address book's repository, so any detail without a column here has to be read from there instead. Extra values that do not fit the fixed columns can be attached as contact extended properties.

Group: Database Entities

Implements: Serializable


Properties

PropertyReturnsDescription
addressBookAddressBookThe address book this contact belongs to. Never null; a contact cannot exist outside an address book.
givenNameStringThe person's first name. May be null, since only the resource name and the uid are required.
idLongGenerated primary key of the contact. Null until the record has been saved.
mailStringThe contact's email address, copied out of the full record so it can be searched on. May be null, and only one address is kept here even where the full record has several.
nameStringThe path-safe resource name the contact is served under within its address book, which is what appears in the WebDAV and CardDAV URL. Never null. It identifies the record and is not a display name; the person's name is held in the given name and surname.
organizationNameStringThe name of the organisation the contact belongs to, as free text copied from the full record. This is a label on the contact and does not link to a Kademi organisation record. May be null.
surNameStringThe person's family name. May be null, since only the resource name and the uid are required.
telephonenumberStringThe contact's phone number as free text, with no formatting or country code rules applied. May be null, and only one number is kept here even where the full record has several.
uidStringThe contact's own unique identifier, as carried in the full record, which stays with the person even if the resource name changes. Never null, and distinct from the resource name returned by getName.

Methods

getId() · getAddressBook() · getName() · getGivenName() · getSurName() · getMail() · getTelephonenumber() · getUid() · getOrganizationName()

getId()

Returns: Long

Generated primary key of the contact. Null until the record has been saved.

getAddressBook()

Returns: AddressBook

The address book this contact belongs to. Never null; a contact cannot exist outside an address book.

getName()

Returns: String

The path-safe resource name the contact is served under within its address book, which is what appears in the WebDAV and CardDAV URL. Never null. It identifies the record and is not a display name; the person's name is held in the given name and surname.

getGivenName()

Returns: String

The person's first name. May be null, since only the resource name and the uid are required.

getSurName()

Returns: String

The person's family name. May be null, since only the resource name and the uid are required.

getMail()

Returns: String

The contact's email address, copied out of the full record so it can be searched on. May be null, and only one address is kept here even where the full record has several.

getTelephonenumber()

Returns: String

The contact's phone number as free text, with no formatting or country code rules applied. May be null, and only one number is kept here even where the full record has several.

getUid()

Returns: String

The contact's own unique identifier, as carried in the full record, which stays with the person even if the resource name changes. Never null, and distinct from the resource name returned by getName.

getOrganizationName()

Returns: String

The name of the organisation the contact belongs to, as free text copied from the full record. This is a label on the contact and does not link to a Kademi organisation record. May be null.

To get full access to the Kademi Hub existing customers can login here, or new customers can register here.