Platform SDK Java 8.5 API Reference

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

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

This request provides a list of Interactions that you can scroll through. The request can be filtered by specifying constraints, or sorted using specified criteria.

Required parameters:

Name Description
setTenantId(java.lang.Integer) The tenant ID from which to return the list of interactions.

Related Events:
Name Description
EventInteractionListGet This event returns a list of Interactions matching the criteria specified by RequestInteractionListGet.
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
RequestInteractionListGet()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestInteractionListGet 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 that will be returned for each matching interaction.
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 DataSourceType getDataSource()
          String value to identify whether the search should be processed in the "main" or "archive" UCS database.
 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()
           
 java.lang.Integer getPageMaxSize()
          The maximum page size for interactions that are returned.
 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 interactions belong to.
 java.lang.Integer getTenantId()
          An integer value specifying the tenant.
 int hashCode()
           
 void setAttributeList(StringList value)
          The list of attributes that will be returned for each matching interaction.
 void setDataSource(DataSourceType value)
          String value to identify whether the search should be processed in the "main" or "archive" UCS database.
 void setEntityTypeId(EntityTypes value)
          An integer value that specifies the entity type to return, limiting interactions in the list to a particular type.
 void setPageMaxSize(java.lang.Integer value)
          The maximum page size for interactions that are returned.
 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 interactions belong to.
 void setTenantId(java.lang.Integer value)
          An integer value specifying the tenant.
 
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

RequestInteractionListGet

public RequestInteractionListGet()
Method Detail

create

public static RequestInteractionListGet create()

getTenantId

public java.lang.Integer getTenantId()
An integer value specifying the tenant.


setTenantId

public void setTenantId(java.lang.Integer value)
An integer value specifying the tenant.


getSubscriberId

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


setSubscriberId

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


getPageMaxSize

public java.lang.Integer getPageMaxSize()
The maximum page size for interactions that are returned. If no value is provided, then the max-select-count parameter value (as configured in the UCS Application object) is used.


setPageMaxSize

public void setPageMaxSize(java.lang.Integer value)
The maximum page size for interactions that are returned. If no value is provided, then the max-select-count parameter value (as configured in the UCS Application object) is used.


getDataSource

public DataSourceType getDataSource()
String value to identify whether the search should be processed in the "main" or "archive" UCS database. Default value is "main".


setDataSource

public void setDataSource(DataSourceType value)
String value to identify whether the search should be processed in the "main" or "archive" UCS database. Default value is "main".


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.


getAttributeList

public StringList getAttributeList()
The list of attributes that will be returned for each matching interaction.


setAttributeList

public void setAttributeList(StringList value)
The list of attributes that will be returned for each matching interaction.


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:


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.