Platform SDK Java 8.5 API Reference

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

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

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.

Related Events:
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

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

RequestGetInteractionsForContact

public RequestGetInteractionsForContact()
Method Detail

create

public static RequestGetInteractionsForContact create()

getAttributeList

public StringList getAttributeList()
The list of attributes, which have to be delivered with each interaction.


setAttributeList

public void setAttributeList(StringList value)
The list of attributes, which have to be delivered with each interaction.


getContactId

public java.lang.String getContactId()
Unique Contact Id, whose interactions are requested.


setContactId

public void setContactId(java.lang.String value)
Unique Contact Id, whose interactions are requested.


getEntityTypeId

public EntityTypes getEntityTypeId()
An integer value that specifies the entity type to return, limiting interactions in the list to a particular type. If this parameter is not set, then interactions are still returned but entity specific information cannot be searched.

Possible values are:


setEntityTypeId

public void setEntityTypeId(EntityTypes value)
An integer value that specifies the entity type to return, limiting interactions in the list to a particular type. If this parameter is not set, then interactions are still returned but entity specific information cannot be searched.

Possible values are:


getSearchCriteria

public SearchCriteriaCollection getSearchCriteria()
No filtering if not present.


setSearchCriteria

public void setSearchCriteria(SearchCriteriaCollection value)
No filtering if not present.


getSortCriteria

public SortCriteriaCollection getSortCriteria()
No ordering if not present.


setSortCriteria

public void setSortCriteria(SortCriteriaCollection value)
No ordering if not present.


getTenantId

public java.lang.Integer getTenantId()
The Tenant of the Contact and its Interactions.


setTenantId

public void setTenantId(java.lang.Integer value)
The Tenant of the Contact and its Interactions.


getDataSource

public DataSourceType getDataSource()

setDataSource

public void setDataSource(DataSourceType 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.


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.