|
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.RequestInteractionListGet
public final class RequestInteractionListGet
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. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestInteractionListGet()
Method Detail |
---|
public static RequestInteractionListGet create()
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.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 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 |