|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.events.EventIdentifyContact
public final class 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.
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public EventIdentifyContact()
Method Detail |
---|
public static EventIdentifyContact create()
public java.lang.Integer getNumberOfContactsFound()
public void setNumberOfContactsFound(java.lang.Integer value)
public StringList getContactIdList()
public void setContactIdList(StringList value)
public java.lang.Boolean getContactCreated()
public void setContactCreated(java.lang.Boolean value)
public java.lang.String getContactId()
public void setContactId(java.lang.String value)
public KeyValueCollection getOtherFields()
public void setOtherFields(KeyValueCollection value)
public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |