|
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.requests.RequestGetInteractionsForContact
public final class RequestGetInteractionsForContact
This request is intended for delivering all or some of the interactions
(depending on filtering) for the contact in question. The aim of this request is to provide
the Interaction history. It returns only attributes from the Interaction table. It cannot be
otherwise because we cannot get MediaServer specific attributes (which are scattered in
multiple tables) in one request. Specific MediaServers attributes may be retrieved individually
by calling the RequetGetInteractionContent.
Required parameters:
Name | Description |
---|---|
setContactId(java.lang.String) |
Unique ID of the contact whose interactions are requested. |
Name | Description |
---|---|
EventGetInteractionsForContact |
This event returns all (or some, depending on filtering) of the interactions for a specified Contact. The purpose of this event is to provide the Interaction history. Only attributes from the Interaction table are returned. Specific MediaServers attributes may be retrieved individually by calling RequestGetInteractionContent. |
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 | |
---|---|
RequestGetInteractionsForContact()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestGetInteractionsForContact |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
StringList |
getAttributeList()
The list of attributes, which have to be delivered with each interaction. |
java.util.Map |
getCompounds()
|
java.lang.String |
getContactId()
Unique Contact Id, whose interactions are requested. |
java.util.List |
getCustomPackagers()
|
DataSourceType |
getDataSource()
|
EntityTypes |
getEntityTypeId()
An integer value that specifies the entity type to return, limiting interactions in the list to a particular type. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
SearchCriteriaCollection |
getSearchCriteria()
No filtering if not present. |
SortCriteriaCollection |
getSortCriteria()
No ordering if not present. |
java.lang.String |
getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the contact belongs to. |
java.lang.Integer |
getTenantId()
The Tenant of the Contact and its Interactions. |
int |
hashCode()
|
void |
setAttributeList(StringList value)
The list of attributes, which have to be delivered with each interaction. |
void |
setContactId(java.lang.String value)
Unique Contact Id, whose interactions are requested. |
void |
setDataSource(DataSourceType value)
|
void |
setEntityTypeId(EntityTypes value)
An integer value that specifies the entity type to return, limiting interactions in the list to a particular type. |
void |
setSearchCriteria(SearchCriteriaCollection value)
No filtering if not present. |
void |
setSortCriteria(SortCriteriaCollection value)
No ordering if not present. |
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)
The Tenant of the Contact and its Interactions. |
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 RequestGetInteractionsForContact()
Method Detail |
---|
public static RequestGetInteractionsForContact create()
public StringList getAttributeList()
public void setAttributeList(StringList value)
public java.lang.String getContactId()
public void setContactId(java.lang.String value)
public EntityTypes getEntityTypeId()
public void setEntityTypeId(EntityTypes value)
public SearchCriteriaCollection getSearchCriteria()
public void setSearchCriteria(SearchCriteriaCollection value)
public SortCriteriaCollection getSortCriteria()
public void setSortCriteria(SortCriteriaCollection value)
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public DataSourceType getDataSource()
public void setDataSource(DataSourceType value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String 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 |