Platform SDK Java 8.5 API Reference

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

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.RequestIdentifyContact
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 RequestIdentifyContact
extends AbstractMessage

This request is intended for identifying a Contact based on user data values. If one or more Contact is found, the Contact identifiers are returned in EventIdentifyContact. If no matching Contact is found, then a new Contact may be created.

Required parameters:

Name Description
setTenantId(java.lang.Integer) The unique tenant ID.

Related Events:
Name Description
EventIdentifyContact This event returns a list of one or more Contact IDs based on user data values specified in the related RequestIdentifyContact request. Use this event to check the number of matching contacts, the specific ID(s), or to see if a new contact was created successfully.
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
RequestIdentifyContact()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestIdentifyContact create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.util.Map getCompounds()
           
 java.lang.Boolean getCreateContact()
          This string specifies whether to get a creation strategy from the Media configuration.
 java.util.List getCustomPackagers()
           
 java.util.Date getDatePattern()
          A string to specify the date pattern format.
 java.lang.String getMediaType()
          UCS uses this parameter to apply the contact identification strategy based on your configuration settings.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 KeyValueCollection getOtherFields()
           
 java.lang.Boolean getReturnUnique()
          This parameter specifies behavior if more than 1 contact is found.
 java.lang.String getSubscriberId()
          The subscriber (i.e. line of business) within the tenant to which the contact belongs to.
 java.lang.Integer getTenantId()
           
 java.lang.Boolean getUpdateUserData()
           
 int hashCode()
           
 void setCreateContact(java.lang.Boolean value)
          This string specifies whether to get a creation strategy from the Media configuration.
 void setDatePattern(java.util.Date value)
          A string to specify the date pattern format.
 void setMediaType(java.lang.String value)
          UCS uses this parameter to apply the contact identification strategy based on your configuration settings.
 void setOtherFields(KeyValueCollection value)
           
 void setReturnUnique(java.lang.Boolean value)
          This parameter specifies behavior if more than 1 contact is found.
 void setSubscriberId(java.lang.String value)
          The subscriber (i.e. line of business) within the tenant to which the contact belongs to.
 void setTenantId(java.lang.Integer value)
           
 void setUpdateUserData(java.lang.Boolean value)
           
 
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

RequestIdentifyContact

public RequestIdentifyContact()
Method Detail

create

public static RequestIdentifyContact create()

getReturnUnique

public java.lang.Boolean getReturnUnique()
This parameter specifies behavior if more than 1 contact is found. If Return is set to TRUE, then UCS does not return a sublist of found contact IDs; if set to FALSE, then a list of all matching contact IDs is returned. The default value is FALSE.


setReturnUnique

public void setReturnUnique(java.lang.Boolean value)
This parameter specifies behavior if more than 1 contact is found. If Return is set to TRUE, then UCS does not return a sublist of found contact IDs; if set to FALSE, then a list of all matching contact IDs is returned. The default value is FALSE.


getUpdateUserData

public java.lang.Boolean getUpdateUserData()

setUpdateUserData

public void setUpdateUserData(java.lang.Boolean value)

getDatePattern

public java.util.Date getDatePattern()
A string to specify the date pattern format. The default value is "yyyy-MM-ddTHH:mm:ssZ".


setDatePattern

public void setDatePattern(java.util.Date value)
A string to specify the date pattern format. The default value is "yyyy-MM-ddTHH:mm:ssZ".


getCreateContact

public java.lang.Boolean getCreateContact()
This string specifies whether to get a creation strategy from the Media configuration. Set this value to FALSE to use the Media configuration; otherwise use TRUE.


setCreateContact

public void setCreateContact(java.lang.Boolean value)
This string specifies whether to get a creation strategy from the Media configuration. Set this value to FALSE to use the Media configuration; otherwise use TRUE.


getTenantId

public java.lang.Integer getTenantId()

setTenantId

public void setTenantId(java.lang.Integer value)

getSubscriberId

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


setSubscriberId

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


getMediaType

public java.lang.String getMediaType()
UCS uses this parameter to apply the contact identification strategy based on your configuration settings.


setMediaType

public void setMediaType(java.lang.String value)
UCS uses this parameter to apply the contact identification strategy based on your configuration settings.


getOtherFields

public KeyValueCollection getOtherFields()

setOtherFields

public void setOtherFields(KeyValueCollection value)

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.