EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class RequestContactListGet extends AbstractMessage
Name | Description |
---|---|
setTenantId(java.lang.Integer) |
The unique tenant ID. |
Name | Description |
---|---|
EventContactListGet |
This event indicates that the RequestContactListGet was successful, and contains a list of contacts matching the criteria specified in that request. Note that data returned in EventContactListGet comes from the Contact table only. In the same way, the ordering of the Contacts returned is done using Contact data only. |
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 |
---|---|
RequestContactListGet() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static RequestContactListGet |
create() |
|
DataSupport |
createClone(DataSupport sample) |
|
Message |
createEspMessage() |
For internal usage only
|
boolean |
equals(java.lang.Object obj) |
|
StringList |
getAttributeList() |
List of sortable attributes to return.
|
java.lang.String |
getCloseScroll() |
|
java.util.Map |
getCompounds() |
|
java.lang.Boolean |
getContactCount() |
Total count of matching Contacts.
|
java.util.List |
getCustomPackagers() |
|
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() |
If no value is provided, UCS configured value (settings/max-select-count) is used.
|
java.lang.Boolean |
getRestricted() |
If TRUE, filtering uses primary sortable attributes (Contact table),
if FALSE, filtering uses all attributes (ContactAttribute table).
|
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 contacts belong to.
|
java.lang.Integer |
getTenantId() |
|
int |
hashCode() |
|
void |
setAttributeList(StringList value) |
List of sortable attributes to return.
|
void |
setCloseScroll(java.lang.String value) |
|
void |
setContactCount(java.lang.Boolean value) |
Total count of matching Contacts.
|
void |
setESQuery(java.lang.String value) |
|
void |
setPageMaxSize(java.lang.Integer value) |
If no value is provided, UCS configured value (settings/max-select-count) is used.
|
void |
setRestricted(java.lang.Boolean value) |
If TRUE, filtering uses primary sortable attributes (Contact table),
if FALSE, filtering uses all attributes (ContactAttribute table).
|
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 contacts belong to.
|
void |
setTenantId(java.lang.Integer value) |
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 RequestContactListGet 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.Boolean getContactCount()
public void setContactCount(java.lang.Boolean value)
public java.lang.Boolean getRestricted()
public void setRestricted(java.lang.Boolean value)
public java.lang.Integer getPageMaxSize()
public void setPageMaxSize(java.lang.Integer value)
public StringList getAttributeList()
public void setAttributeList(StringList value)
public SearchCriteriaCollection getSearchCriteria()
public void setSearchCriteria(SearchCriteriaCollection value)
public SortCriteriaCollection getSortCriteria()
public void setSortCriteria(SortCriteriaCollection 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.