Interaction SDK
(Web Services)

com.genesyslab.ail.ws.contact

Class Summary
ContactAttribute This class contains the contact attribute values of a contact attribute.
ContactAttributeCreate This class describes the form to create a contact.
ContactAttributeMetaData This class describes the metadata of a contact attribute. The metadata contains useful information available for all the values of this type of contact attribute. For example, a metadata can describe an e-mail address; this metadata is available for any contact attribute value which contains an e-mail address. ContactAttributeMetaData is defined in the Configuration Layer in the Business Attributes/Contact Attributes enumerator folder.
ContactAttributePredefinedMetaData This class describes a predefined contact attribute metadata. Each contact has a contact attribute which corresponds to this metadata.
ContactAttributeRemove This class describes the contact attribute instances to remove.
ContactAttributeValue This class is a container for a contact attribute value. This class has two usages. If the ContactAttributeValue object contains a contact attribute value from the ContactServer database, the isPredefined() method always returns false, and the getId() method returns the ContactServerID. If the ContactAttributeValue object contains a predefined value from the Configuration Layer, the isPredefined() method always returns true, the getId() method returns the name of the Configuration Layer value, and the getValue() method contains the display name in the Configuration Layer, the getDescription() method is the description, and the isPrimary() method returns true if the current value is the default Configuration Layer value.
ContactAttributeValueRemove This class describes the contact attribute values to remove.
ContactError This class defines a contact error.
ContactFilterLeaf This class describes a contact filter leaf. A contact filter leaf contains an expression such as: "EMailAddress = myE-Mail@Address.com" or "primary EMailAddress == myE-Mail@Address.com"
ContactFilterNode This class describes a filter node. A filter node is an expression such as: node AND node AND ... AND leaf AND leaf.
ContactFilterRoot This class describes the contact filter root of a contact filter tree. The filter root contains one filter node xor one filter leaf.
ContactInfo Describes the additional information of a contact.
ContactMergeDetail Contains information about the last merge action performed on a contact.
ContactMergeForm This class describes the form used to merge two contacts. The 'from' contact attributes are not deleted, all its contact attribute values are assigned to the 'to' contact with primary status set to false (if needed). The merge might affect the default values for 'to' contact's attributes. If after merging, no default title is defined for the 'to' contact, the default title of 'from' contact, if it exists, is used for default title for this contact. If after merging, no default first name is defined for the 'to' contact, the default first name of the 'from' contact, if it exists, is used for default firstname for this contact. If after merging no default last name is defined for the 'to' contact, the default last name of the 'from' contact, if it exists, is used for default last name for this contact. If after merging no default e-mail address is defined for the 'to' contact, the default e-mail address of the 'from' contact, if it exists, is used for default e-mail address for this contact. If no default e-mail address exists, another value is taken from the list (if any). If after merging no default phone number is defined for the 'to' contact, the default phone number of the 'from' contact, if it exists, is used for default phone number for this contact. If no default phone number exists, another value is taken from the list (if any).
ContactResult This class defines a set contact result.
ContactRetrieveAttribute This class defines a contact attribute to retrieve.
ContactSearchTemplate This class defines the template for contact searches. It defines a contact filter tree to search contacts and specifies a set of attributes used to sort the matching contacts. The list of matching contacts may be too huge to be retrieved. This form can specify the size and the index of the matching contacts' sorted list which is returned. For example: if index = 0 and length = -1, the returned list contains all the matching contacts; if index = 0 and length = 8, the returned list contains the first eight matching contacts; if index = 8 and length = 8, the returned list contains the next eight matching contacts.
ContactSortAttribute This class defines the contact attributes to sort.
ContactValue This class describes the information of a contact. Each object reference is unique, two or several client applications do not handle the same reference even though the ID of the contact (ContactServerID) is identical. Objects, that handle the same contact ID, may not store the same contact attribute values. Therefore, one contact value object can contain a subset of contact attribute values of another contact value object with the same contact identifier that is fullfilled.

Enum Summary
ContactAttributeMetaDataType This enum describes the different types of a contact attribute metadata.
ContactAttributePredefinedMetaDataType This enum lists the predefined types of a contact attribute metadata.
ContactFilterLeafOperator This enum describes the constants for the operator of a contact filter leaf.
ContactFilterNodeOperator This enum describes the constants for the operator of a contact filter node.
ContactUpdateType This enum describes the different types of a contact update.

Class Detail

ContactAttribute

This class contains the contact attribute values of a contact attribute.

Fields:

  values  com.genesyslab.ail.ws.contact.ContactAttributeValue[]
   The contact attribute values of the attribute.

  attributeMetaDataId  String
   The identifier of the attribute metadata which describes the attribute.

ContactAttributeCreate

This class describes the form to create a contact.

Fields:

  attributes  com.genesyslab.ail.ws.contact.ContactAttribute[]
   The contact attributes.

ContactAttributeMetaData

This class describes the metadata of a contact attribute. The metadata contains useful information available for all the values of this type of contact attribute. For example, a metadata can describe an e-mail address; this metadata is available for any contact attribute value which contains an e-mail address. ContactAttributeMetaData is defined in the Configuration Layer in the Business Attributes/Contact Attributes enumerator folder.

Fields:

  name  String
   The attribute metadata name.

  displayName  String
   The attribute display name.

  format  String
   The format of this attribute.

  modifiedDate  long
   The data this attribute was modified.

  id  String
   The attribute metadata identifier.

  type  com.genesyslab.ail.ws.contact.ContactAttributeMetaDataType
   The type of this attribute.

  active  boolean
   true, if this attribute is active in the Contact Server.

  caseSensitive  boolean
   true, if this attribute is case-sensitive.

  searchable  boolean
   true, if this attribute is searchable.

  sortable  boolean
   true, if this attribute is sortable.

  predefinedValues  com.genesyslab.ail.ws.contact.ContactAttributeValue[]
   A list of predefined contact attribute values; otherwise null, if no predefined values. For example: Title ContactAttributeMetaData has 3 predefined ContactAttributeValues with: "Mr", "Ms", "Miss".

ContactAttributePredefinedMetaData

This class describes a predefined contact attribute metadata. Each contact has a contact attribute which corresponds to this metadata.

Fields:

  predefinedType  com.genesyslab.ail.ws.contact.ContactAttributePredefinedMetaDataType
   The fixed contact attribute.

  metaData  com.genesyslab.ail.ws.contact.ContactAttributeMetaData
   The metadata.

ContactAttributeRemove

This class describes the contact attribute instances to remove.

Fields:

  attributes  com.genesyslab.ail.ws.contact.ContactAttributeValueRemove[]
   The contact attributes to remove.

  contactId  String
   The contact identifier.

ContactAttributeValue

This class is a container for a contact attribute value. This class has two usages. If the ContactAttributeValue object contains a contact attribute value from the ContactServer database, the isPredefined() method always returns false, and the getId() method returns the ContactServerID. If the ContactAttributeValue object contains a predefined value from the Configuration Layer, the isPredefined() method always returns true, the getId() method returns the name of the Configuration Layer value, and the getValue() method contains the display name in the Configuration Layer, the getDescription() method is the description, and the isPrimary() method returns true if the current value is the default Configuration Layer value.

Fields:

  id  String
   The system identifier of this attribute instance. In set mode, if the ID is null the attribute is added; otherwise, this instance is updated.

  description  String
   The description.

  mimeType  String
   The MIME type of a binary value.

  value  Object
   The attribute value. Can be a String, a byte array, or a long (representing a date).

  primary  boolean
   true, if this attribute instance is a primary one.

  predefined  boolean
   true, if this attribute instance is a predefined one. Uses only in read mode, in write mode this field is not taken account.

ContactAttributeValueRemove

This class describes the contact attribute values to remove.

Fields:

  attributeValueIds  String[]
   The contact attribute values' identifiers.

  attributeMetaDataId  String
   The attribute metadata ID.

ContactError

This class defines a contact error.

Fields:

  contactError  String
   The contact error code.

  contactId  String
   The contact identifier.

  attributeErrors  com.genesyslab.ail.ws.AttributeError[]
   The attribute error codes. For each AttributeError, the AttributeError.attribute field contains the attribute metadata identifier, and the AttributeError.code field contains the raised error code.

ContactFilterLeaf

This class describes a contact filter leaf. A contact filter leaf contains an expression such as: "EMailAddress = myE-Mail@Address.com" or "primary EMailAddress == myE-Mail@Address.com"

Fields:

  attributeMetaDataId  String
   The attribute metadata identifier.

  operator  com.genesyslab.ail.ws.contact.ContactFilterLeafOperator
   The operator.

  value  String
   The value. This value can contain a string for a contact attribute value, and/or a wildcard. The available wildcards are '*': any or '_' : char. Use escape character ('\') that distinguish wildcards ( '\', '_', '*', '%', '[') from normal characters.

  primaryOnly  boolean
   Only primary.

ContactFilterNode

This class describes a filter node. A filter node is an expression such as: node AND node AND ... AND leaf AND leaf.

Fields:

  leaves  com.genesyslab.ail.ws.contact.ContactFilterLeaf[]
   The filter leaves.

  nodes  com.genesyslab.ail.ws.contact.ContactFilterNode[]
   The filter nodes.

  operator  com.genesyslab.ail.ws.contact.ContactFilterNodeOperator
   The operator.

ContactFilterRoot

This class describes the contact filter root of a contact filter tree. The filter root contains one filter node xor one filter leaf.

Fields:

  node  com.genesyslab.ail.ws.contact.ContactFilterNode
   The root filter node; otherwise null, if the filter root contains one leaf.

  leaf  com.genesyslab.ail.ws.contact.ContactFilterLeaf
   The filter leaf; otherwise null, if the filter root contains one node.

ContactInfo

Describes the additional information of a contact.

Fields:

  contactId  String
   The contact identifier.

  undoAvailable  boolean
   Returns true if you can call the ContactService.undoMerge() method for this Contact.

ContactMergeDetail

Contains information about the last merge action performed on a contact.

Fields:

  description  String
   Returns the description of the last merge action performed.

  destinationContactAttributeValues  com.genesyslab.ail.ws.contact.ContactAttributeValue[]
   Returns the attribute values of the destination contact before the merge was processed.

  destinationContactId  String
   Returns the destination contact identifier for the last merge action.

  mergeDate  long
   Returns the date of the last merge action.

  reason  String
   Returns the reason of the last merge action.

  sourceContactAttributeValues  com.genesyslab.ail.ws.contact.ContactAttributeValue[]
   Returns the attribute values of the source contact before the merge was processed.

  sourceContactId  String
   Returns the source contact identifier.

ContactMergeForm

This class describes the form used to merge two contacts. The 'from' contact attributes are not deleted, all its contact attribute values are assigned to the 'to' contact with primary status set to false (if needed). The merge might affect the default values for 'to' contact's attributes. If after merging, no default title is defined for the 'to' contact, the default title of 'from' contact, if it exists, is used for default title for this contact. If after merging, no default first name is defined for the 'to' contact, the default first name of the 'from' contact, if it exists, is used for default firstname for this contact. If after merging no default last name is defined for the 'to' contact, the default last name of the 'from' contact, if it exists, is used for default last name for this contact. If after merging no default e-mail address is defined for the 'to' contact, the default e-mail address of the 'from' contact, if it exists, is used for default e-mail address for this contact. If no default e-mail address exists, another value is taken from the list (if any). If after merging no default phone number is defined for the 'to' contact, the default phone number of the 'from' contact, if it exists, is used for default phone number for this contact. If no default phone number exists, another value is taken from the list (if any).

Fields:

  contactIdTo  String
   The contact identifier to merge to. This contact ID remains after the merge.

  contactIdFrom  String
   The contact identifier to merge from. This contact ID is removed from the database after the merge.

ContactResult

This class defines a set contact result.

Fields:

  contactError  String
   The contact error code (if one).

  contactId  String
   The contact identifier.

  attributeErrors  com.genesyslab.ail.ws.AttributeError[]
   The attribute error codes. For each AttributeError, the AttributeError.attribute field contains the attribute metadata identifier, and the AttributeError.code field contains the raised error code.

  attributes  com.genesyslab.ail.ws.contact.ContactAttribute[]
   The updated contact attributes.

ContactRetrieveAttribute

This class defines a contact attribute to retrieve.

Fields:

  attributeMetaDataId  String
   The contact attribute metadata identifier. It specifies which contact attribute is retrieved.

  primary  boolean
   true, if only the primary value of this attribute is retrieved; otherwise, all the values of the attribute are retrieved.

ContactSearchTemplate

This class defines the template for contact searches. It defines a contact filter tree to search contacts and specifies a set of attributes used to sort the matching contacts. The list of matching contacts may be too huge to be retrieved. This form can specify the size and the index of the matching contacts' sorted list which is returned. For example: if index = 0 and length = -1, the returned list contains all the matching contacts; if index = 0 and length = 8, the returned list contains the first eight matching contacts; if index = 8 and length = 8, the returned list contains the next eight matching contacts.

Fields:

  filter  com.genesyslab.ail.ws.contact.ContactFilterRoot
   The filter root which defines the search criteria.

  index  int
   The index of the first item to return. 0 indicates the first item. A negative value counts from the end.

  length  int
   Length of the list to return, or -1 for unlimited list.

  retrieveAttributes  com.genesyslab.ail.ws.contact.ContactRetrieveAttribute[]
   The attributes to retrieve.

  sortAttributes  com.genesyslab.ail.ws.contact.ContactSortAttribute[]
   The attributes to sort.

  searchPrimaryValueOnly  boolean
   Puts the search flag to true in order to look only for primary value, false flag for all values.

ContactSortAttribute

This class defines the contact attributes to sort.

Fields:

  attributeMetaDataId  String
   The contact attribute identifier to sort.

  reverse  boolean
   The attribute in reverse mode.

ContactValue

This class describes the information of a contact. Each object reference is unique, two or several client applications do not handle the same reference even though the ID of the contact (ContactServerID) is identical. Objects, that handle the same contact ID, may not store the same contact attribute values. Therefore, one contact value object can contain a subset of contact attribute values of another contact value object with the same contact identifier that is fullfilled.

Fields:

  attributes  com.genesyslab.ail.ws.contact.ContactAttribute[]
   The contact attributes.

  contactId  String
   The contact identifier.

Enum Detail

ContactAttributeMetaDataType

This enum describes the different types of a contact attribute metadata.

Members:

  BINARY
   ContactAttribute type Binary.

  STRING
   ContactAttribute type String.

  DATE
   ContactAttribute type date.

ContactAttributePredefinedMetaDataType

This enum lists the predefined types of a contact attribute metadata.

Members:

  TITLE
   Fixed contact attribute : Title.

  FIRSTNAME
   Fixed contact attribute : Firstname.

  LASTNAME
   Fixed contact attribute : Lastname.

  PHONE_NUMBER
   Fixed contact attribute : PhoneNumber.

  EMAIL_ADDRESS
   Fixed contact attribute : EmailAddress.

ContactFilterLeafOperator

This enum describes the constants for the operator of a contact filter leaf.

Members:

  EQUAL
   Constant for the '=' leaf operator.

  NOT_EQUAL
   Constant for the '!=' leaf operator.

ContactFilterNodeOperator

This enum describes the constants for the operator of a contact filter node.

Members:

  AND
   Constant for the 'and' node operator.

  OR
   Constant for the 'or' node operator.

ContactUpdateType

This enum describes the different types of a contact update.

Members:

  UPDATE_ATTRIBUTE
   Update a contact attribute with new contact attribute values.

  OVERWRITE_ATTRIBUTE
   Overwrite the specified contact attributes.

  OVERWRITE_CONTACT
   Overwrite all the contact attributes.

Interaction SDK
(Web Services)