EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class RequestInteractionListGet extends AbstractMessage
Name | Description |
---|---|
setTenantId(java.lang.Integer) |
The tenant ID from which to return the list of interactions. |
Name | Description |
---|---|
EventInteractionListGet |
This event returns a list of Interactions matching the criteria specified by RequestInteractionListGet. |
EventError |
Indicates that the request encountered an error. |
Modifier and Type | Field | Description |
---|---|---|
static int |
ID |
|
static java.lang.String |
NAME |
REF_ID_KEY
Constructor | Description |
---|---|
RequestInteractionListGet() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static RequestInteractionListGet |
create() |
|
DataSupport |
createClone(DataSupport sample) |
|
Message |
createEspMessage() |
For internal usage only
|
boolean |
equals(java.lang.Object obj) |
|
StringList |
getAttributeList() |
The list of attributes that will be returned for each matching interaction.
|
java.lang.String |
getCloseScroll() |
|
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.
|
java.lang.String |
getESQuery() |
|
java.lang.String |
getMessageCategory() |
For internal usage only
|
MetaData |
getMetaData() |
|
java.lang.String |
getMethod() |
For internal usage only
|
java.lang.String |
getMethodKey() |
For internal usage only
|
java.lang.Integer |
getPageMaxSize() |
The maximum page size for interactions that are returned.
|
SearchCriteriaCollection |
getSearchCriteria() |
No filtering if not present.
|
java.lang.String |
getService() |
For internal usage only
|
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 |
setCloseScroll(java.lang.String value) |
|
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 |
setESQuery(java.lang.String value) |
|
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.
|
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestInteractionListGet create()
public java.lang.String getMethodKey()
AbstractMessage
getMethodKey
in class AbstractMessage
public java.lang.String getService()
AbstractMessage
getService
in class AbstractMessage
public java.lang.String getMethod()
AbstractMessage
getMethod
in class AbstractMessage
public java.lang.String getMessageCategory()
AbstractMessage
getMessageCategory
in class AbstractMessage
public Message createEspMessage()
AbstractMessage
createEspMessage
in class AbstractMessage
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String value)
public java.lang.String getESQuery()
public void setESQuery(java.lang.String value)
public java.lang.String getCloseScroll()
public void setCloseScroll(java.lang.String value)
public java.lang.Integer getPageMaxSize()
public void setPageMaxSize(java.lang.Integer value)
public DataSourceType getDataSource()
public void setDataSource(DataSourceType value)
public SearchCriteriaCollection getSearchCriteria()
public void setSearchCriteria(SearchCriteriaCollection value)
public SortCriteriaCollection getSortCriteria()
public void setSortCriteria(SortCriteriaCollection value)
public StringList getAttributeList()
public void setAttributeList(StringList value)
public EntityTypes getEntityTypeId()
public void setEntityTypeId(EntityTypes value)
public MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public DataSupport createClone(DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.