Interaction SDK
(Web Services)

Namespace 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.
 


Interaction SDK
(Web Services)