Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestMergeContacts

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
              extended by com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestMergeContacts
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport

public final class RequestMergeContacts
extends AbstractMessage

Request to merge two existing Contacts.

Required parameters:

Name Description
setDestinationContactId(java.lang.String) ID for the Contact receiving information during the merge.
setSourceContactId(java.lang.String) ID for the contact which will be deleted as a result of the merge.
setTenantId(java.lang.Integer) Unique ID of the tenant.

Related Events:
Name Description
EventMergeContacts Indicates that RequestMergeContacts was successful, and returns the ID of the merge request.
EventError Indicates that the request encountered an error.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Fields inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
REF_ID_KEY
 
Constructor Summary
RequestMergeContacts()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestMergeContacts create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.Integer getAgentId()
          ID of the Agent requesting a merge.
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 java.lang.String getDescription()
          Description of why the merge occurred.
 java.lang.String getDestinationContactId()
          ID for the Contact receiving information during the merge.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.String getReason()
          Reason why this merge is being made.
 java.lang.String getSourceContactId()
          ID for the contact which will be deleted as a result of the merge.
 java.lang.String getSubscriberId()
          The subscriber (i.e. line of business) within the tenant to which the contacts belong to.
 java.lang.Integer getTenantId()
          Tenant ID.
 int hashCode()
           
 void setAgentId(java.lang.Integer value)
          ID of the Agent requesting a merge.
 void setDescription(java.lang.String value)
          Description of why the merge occurred.
 void setDestinationContactId(java.lang.String value)
          ID for the Contact receiving information during the merge.
 void setReason(java.lang.String value)
          Reason why this merge is being made.
 void setSourceContactId(java.lang.String value)
          ID for the contact which will be deleted as a result of the merge.
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. line of business) within the tenant to which the contacts belong to.
 void setTenantId(java.lang.Integer value)
          Tenant ID.
 
Methods inherited from class com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.protocol.ProtocolDescriptionSupport
getProtocolDescription
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

RequestMergeContacts

public RequestMergeContacts()
Method Detail

create

public static RequestMergeContacts create()

getAgentId

public java.lang.Integer getAgentId()
ID of the Agent requesting a merge.


setAgentId

public void setAgentId(java.lang.Integer value)
ID of the Agent requesting a merge.


getDescription

public java.lang.String getDescription()
Description of why the merge occurred.


setDescription

public void setDescription(java.lang.String value)
Description of why the merge occurred.


getSourceContactId

public java.lang.String getSourceContactId()
ID for the contact which will be deleted as a result of the merge.


setSourceContactId

public void setSourceContactId(java.lang.String value)
ID for the contact which will be deleted as a result of the merge.


getDestinationContactId

public java.lang.String getDestinationContactId()
ID for the Contact receiving information during the merge.


setDestinationContactId

public void setDestinationContactId(java.lang.String value)
ID for the Contact receiving information during the merge.


getReason

public java.lang.String getReason()
Reason why this merge is being made.


setReason

public void setReason(java.lang.String value)
Reason why this merge is being made.


getTenantId

public java.lang.Integer getTenantId()
Tenant ID.


setTenantId

public void setTenantId(java.lang.Integer value)
Tenant ID.


getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the contacts belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the contacts belong to.


getMetaData

public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
Overrides:
getCustomPackagers in class AbstractMessage

attributes

public java.util.Map attributes()

getCompounds

public java.util.Map getCompounds()

createClone

public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)

hashCode

public int hashCode()
Overrides:
hashCode in class DataObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class DataObject

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.