Class ContactIdentifier

java.lang.Object
com.novomind.ecom.api.iagent.model.ContactIdentifier

public final class ContactIdentifier extends Object
A ContactIdentifier is an object containing information which will be normally used as secondary search criteria while searching an existing contact if the primary search criterion does not find a contact. The primary search criterion depends on the type of Issue. The search with the secondary search criteria will always start with the email addresses, then the phone numbers and lastly the contact attributes while preserving the insertion order of the specific criterion type. If a search criterion finds a contact the search will be stopped and no further search criteria will be used. The contact information will be assigned to the existing or newly created contact.
Since:
11.32
  • Constructor Details

    • ContactIdentifier

      public ContactIdentifier()
  • Method Details

    • addEmailAddress

      public ContactIdentifier addEmailAddress(jakarta.mail.internet.InternetAddress emailAddress)
      Adds a new email address to the contact identifier.
      Parameters:
      emailAddress - an email address associated with the contact
      Returns:
      the instance for fluent usage
      Since:
      11.32
    • addPhoneNumber

      public ContactIdentifier addPhoneNumber(String phoneNumber)
      Adds a new phone number to the contact identifier. The phone number must be an international number and should be formatted using the E.164 recommendation.
      Parameters:
      phoneNumber - an international phone number associated with the contact
      Returns:
      the instance for fluent usage
      Since:
      11.32
    • addAttribute

      public ContactIdentifier addAttribute(String key, String value)
      Adds a new attribute to the contact identifier. Multiple values can be added separately to the same key.
      Parameters:
      key - the key of the attribute
      value - the value of the attribute
      Returns:
      the instance for fluent usage
      Since:
      11.32
    • getEmailAddresses

      public Set<jakarta.mail.internet.InternetAddress> getEmailAddresses()
      Returns:
      the unmodifiable Set of email addresses preserving the insertion order
      Since:
      11.32
    • getPhoneNumbers

      public Set<String> getPhoneNumbers()
      Returns:
      the unmodifiable Set of phone numbers preserving the insertion order
      Since:
      11.32
    • getAttributes

      public Map<String,Set<String>> getAttributes()
      Returns:
      the unmodifiable Map of attributes preserving the insertion order
      Since:
      11.32