|
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.RequestContactListGet
public final class RequestContactListGet
This request is intended for building a ScrollableList object based on
provided constraints. Depending on the Restricted parameter, lookup filter is applied in
Contact table or in ContactAttribute table. Depending on database indexes, the type of
Operator used, the size of the tables, and many other parameters, it can be more interesting
(in terms of performance) to set Restricted to TRUE or to FALSE. There is no general rule and
this really depends on the filter used, and on the database used. Because the Contact table
contains only a subset of Contact Attribute values (they are called sortable Contact Attributes),
it is not possible to use any Contact Attribute in a filter when Restricted is set to TRUE. Note
also that the data returned by the lookup request comes from the Contact table only. In the same
way, the ordering of the Contacts returned is done using Contact data only.
Required parameters:
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. |
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 | |
---|---|
RequestContactListGet()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestContactListGet |
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()
List of sortable attributes to return. |
java.util.Map |
getCompounds()
|
java.lang.Boolean |
getContactCount()
Total count of matching Contacts. |
java.util.List |
getCustomPackagers()
|
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
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. |
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 |
setContactCount(java.lang.Boolean value)
Total count of matching Contacts. |
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)
|
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 RequestContactListGet()
Method Detail |
---|
public static RequestContactListGet 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 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 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 |