EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class RequestGetContacts extends AbstractMessage
Name | Description |
---|---|
getTenantId() |
The unique tenant ID. |
Name | Description |
---|---|
EventGetContacts |
This event delivers a specific range of contacts, based on your search and sort criteria. |
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 |
---|---|
RequestGetContacts() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static RequestGetContacts |
create() |
|
DataSupport |
createClone(DataSupport sample) |
|
Message |
createEspMessage() |
For internal usage only
|
boolean |
equals(java.lang.Object obj) |
|
StringList |
getAttributeList() |
|
java.util.Map |
getCompounds() |
|
java.lang.Boolean |
getContactCount() |
Asks UCS to return total count of matching Contacts.
|
java.util.List |
getCustomPackagers() |
|
java.lang.Integer |
getIndexOfFirst() |
Index of the first row in selection.
|
java.lang.Integer |
getMaxCount() |
Maximum number of rows in selection.
|
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.Boolean |
getRestricted() |
If TRUE, filtering uses primary sortable attributes (Contact table), if FALSE, filtering uses all attributes (ContactAttribute table).
|
SearchCriteriaCollection |
getSearchCriteria() |
|
java.lang.String |
getService() |
For internal usage only
|
SortCriteriaCollection |
getSortCriteria() |
|
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) |
|
void |
setContactCount(java.lang.Boolean value) |
Asks UCS to return total count of matching Contacts.
|
void |
setIndexOfFirst(java.lang.Integer value) |
Index of the first row in selection.
|
void |
setMaxCount(java.lang.Integer value) |
Maximum number of rows in selection.
|
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) |
|
void |
setSortCriteria(SortCriteriaCollection value) |
|
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 RequestGetContacts 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.Boolean getRestricted()
public void setRestricted(java.lang.Boolean value)
public java.lang.Boolean getContactCount()
public void setContactCount(java.lang.Boolean 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 java.lang.Integer getIndexOfFirst()
public void setIndexOfFirst(java.lang.Integer value)
public java.lang.Integer getMaxCount()
public void setMaxCount(java.lang.Integer 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.