|
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.RequestGetContacts
public final class RequestGetContacts
This request is intended for delivering a specific range of contacts based
on search and sort criteria.
Required parameters:
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. |
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 | |
---|---|
RequestGetContacts()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestGetContacts |
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()
|
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. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
java.lang.Boolean |
getRestricted()
If TRUE, filtering uses primary sortable attributes (Contact table), if FALSE, filtering uses all attributes (ContactAttribute table). |
SearchCriteriaCollection |
getSearchCriteria()
|
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)
|
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 RequestGetContacts()
Method Detail |
---|
public static RequestGetContacts 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.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 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 |