Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.events
Class EventIdentifyContact

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.events.EventIdentifyContact
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 EventIdentifyContact
extends AbstractMessage

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.


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
EventIdentifyContact()
           
 
Method Summary
 java.util.Map attributes()
           
static EventIdentifyContact 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 getContactCreated()
          TRUE is a new contact was created because of the associated request; otherwise FALSE.
 java.lang.String getContactId()
          The ID of the matching Contact, if only one match was found.
 StringList getContactIdList()
          A list of IDs for the matching Contact, if more than one match was found.
 java.util.List getCustomPackagers()
           
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Integer getNumberOfContactsFound()
          The number of matching contacts returned.
 KeyValueCollection getOtherFields()
           
 int hashCode()
           
 void setContactCreated(java.lang.Boolean value)
          TRUE is a new contact was created because of the associated request; otherwise FALSE.
 void setContactId(java.lang.String value)
          The ID of the matching Contact, if only one match was found.
 void setContactIdList(StringList value)
          A list of IDs for the matching Contact, if more than one match was found.
 void setNumberOfContactsFound(java.lang.Integer value)
          The number of matching contacts returned.
 void setOtherFields(KeyValueCollection 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

EventIdentifyContact

public EventIdentifyContact()
Method Detail

create

public static EventIdentifyContact create()

getNumberOfContactsFound

public java.lang.Integer getNumberOfContactsFound()
The number of matching contacts returned.


setNumberOfContactsFound

public void setNumberOfContactsFound(java.lang.Integer value)
The number of matching contacts returned.


getContactIdList

public StringList getContactIdList()
A list of IDs for the matching Contact, if more than one match was found.


setContactIdList

public void setContactIdList(StringList value)
A list of IDs for the matching Contact, if more than one match was found.


getContactCreated

public java.lang.Boolean getContactCreated()
TRUE is a new contact was created because of the associated request; otherwise FALSE.


setContactCreated

public void setContactCreated(java.lang.Boolean value)
TRUE is a new contact was created because of the associated request; otherwise FALSE.


getContactId

public java.lang.String getContactId()
The ID of the matching Contact, if only one match was found.


setContactId

public void setContactId(java.lang.String value)
The ID of the matching Contact, if only one match was found.


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.