Interface BaseContact

  • All Known Subinterfaces:
    Contact, EditableContact

    public interface BaseContact
    Base class used as a common interface for read-only and editable contacts.
    • Method Detail

      • getASCIILastName

        ContactStringField getASCIILastName()
        The non-localized last name.
        Returns:
        Contact string field containing non-localized last name.
      • getASCIIFirstName

        ContactStringField getASCIIFirstName()
        The non-localized first name.
        Returns:
        Contact string field containing non-localized first name.
      • getASCIIDisplayName

        ContactStringField getASCIIDisplayName()
        The non-localized display name.
        Returns:
        Contact string field containing non-localized display name.
      • getASCIIAlias

        ContactStringField getASCIIAlias()
        The non-localized alias.
        Returns:
        Contact string field containing a non-localized alias.
      • getNativeLastName

        ContactStringField getNativeLastName()
        The native last name.
        Returns:
        Contact string field containing the native last name.
      • getNativeFirstName

        ContactStringField getNativeFirstName()
        The native first name.
        Returns:
        Contact string field containing the native first name.
      • getNativeDisplayName

        ContactStringField getNativeDisplayName()
        The native display name.
        Returns:
        Contact string field containing the native display name.
      • getNativeAlias

        ContactStringField getNativeAlias()
        The native alias.
        Returns:
        Contact string field containing the native alias.
      • getLocation

        ContactStringField getLocation()
        The location.
        Returns:
        Contact string field containing the location.
      • getStreetAddress

        ContactStringField getStreetAddress()
        The street address.
        Returns:
        Contact string field containing the street address.
      • getCity

        ContactStringField getCity()
        The city.
        Returns:
        Contact string field containing the city.
      • getState

        ContactStringField getState()
        The state.
        Returns:
        Contact string field containing the state.
      • getCountry

        ContactStringField getCountry()
        The country.
        Returns:
        Contact string field containing the country.
      • getPostalCode

        ContactStringField getPostalCode()
        The postal code.
        Returns:
        Contact string field containing the postal code.
      • getCompany

        ContactStringField getCompany()
        The company.
        Returns:
        Contact string field containing the company.
      • getDepartment

        ContactStringField getDepartment()
        The department.
        Returns:
        Contact string field containing the department.
      • getManager

        ContactStringField getManager()
        The name of a person who is a supervisor.
        Returns:
        Contact string field containing the name of a person who is a supervisor.
      • getTitle

        ContactStringField getTitle()
        The title or company role.
        Returns:
        Contact string field containing the title or company role.
      • getLanguage

        ContactStringField getLanguage()
        The language is per contact record.
        Returns:
        Contact string field containing the language is per contact record.
      • getUniqueAddressForMatching

        java.lang.String getUniqueAddressForMatching()
        The matching/merging address. This parameter can be used as a record's unique id.
        Returns:
        Contact string field containing the matching/merging address.
      • isBuddy

        ContactBoolField isBuddy()
        The buddy flag. Used for presence feature purpose.
        Returns:
        Contact bool field containing the buddy flag.
      • isVIP

        ContactBoolField isVIP()
        The VIP flag.
        Returns:
        Contact bool field containing the VIP flag.
      • isFavorite

        ContactBoolField isFavorite()
        The favorite flag.
        Returns:
        Contact bool field containing the favorite flag.
      • getNotes

        ContactStringField getNotes()
        The notes field.
        Returns:
        Contact string field containing the notes field.
      • getRank

        ContactDoubleField getRank()
        The rank field defining the contact sorting order. 0.0 value means "No rank". Higher values are sorted toward top of the list.
        Returns:
        Non-negative double value.
      • getExtraFields

        java.util.Map<java.lang.String,​ContactField> getExtraFields()
        Contact extra fields
        Returns:
        Map object containing contact extra fields as ContactField with String key. Key values are in ExtraFieldKeys class.
      • isExtendedContactDetailsAvailable

        boolean isExtendedContactDetailsAvailable()
        Returns true if extended contact details are available.
        Returns:
        true if extended contact details are available.
      • canAddPhoneNumber

        boolean canAddPhoneNumber​(ContactPhoneNumberType contactPhoneNumberType)
        Returns true if addition of phone number of a specified type will not make contact invalid.
        Parameters:
        contactPhoneNumberType - type of phone number.
        Returns:
        true if addition of phone number of a given ContactPhoneNumberType is allowed.
      • canAddEmailAddress

        @Deprecated
        boolean canAddEmailAddress()
        Deprecated.
        THIS METHOD WILL BE REMOVED IN RELEASE VERSION 3.3.
        Returns true if addition of email address will not make contact invalid.
        Returns:
        true if addition of email address will not make contact invalid.
      • canAddEmailAddress

        boolean canAddEmailAddress​(ContactEmailAddressType contactEmailAddressType)
        Returns true if addition of email address of a specified type will not make contact invalid.
        Parameters:
        contactEmailAddressType - type of email address.
        Returns:
        true if addition of email address of a given ContactEmailAddressType is allowed.
      • canAddIMAddress

        boolean canAddIMAddress()
        Returns true if addition of IM address will not make contact invalid.
        Returns:
        true if addition of IM address will not make contact invalid.
      • isVideoCapable

        ContactBoolField isVideoCapable()
        Returns true if contact is video capable.
        Returns:
        true if Contact is video capable.