|
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.events.EventContactListGet
public final class 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.
Selected Properties:
Name | Description |
---|---|
getPageSize() |
The number of Contacts available in this page. |
getHasNext() |
Indicates that more records are available. |
Name | Description |
---|---|
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. |
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 | |
---|---|
EventContactListGet()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static EventContactListGet |
create()
|
com.genesyslab.platform.commons.protocol.runtime.DataSupport |
createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
|
boolean |
equals(java.lang.Object obj)
|
java.util.Map |
getCompounds()
|
ContactDataList |
getContactData()
|
java.util.List |
getCustomPackagers()
|
java.lang.Boolean |
getHasNext()
Indicates more records are available (using RequestContactListGetNextPage). |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
java.lang.Integer |
getPageSize()
The number of Contacts available in this page. |
java.lang.String |
getScrollId()
This ID is used to call RequestContactListGetNextPage. |
java.lang.Integer |
getTotalCount()
Present only if ContactCount=TRUE in the request. |
int |
hashCode()
|
void |
setContactData(ContactDataList value)
|
void |
setHasNext(java.lang.Boolean value)
Indicates more records are available (using RequestContactListGetNextPage). |
void |
setPageSize(java.lang.Integer value)
The number of Contacts available in this page. |
void |
setScrollId(java.lang.String value)
This ID is used to call RequestContactListGetNextPage. |
void |
setTotalCount(java.lang.Integer value)
Present only if ContactCount=TRUE in the request. |
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 EventContactListGet()
Method Detail |
---|
public static EventContactListGet create()
public java.lang.Boolean getHasNext()
public void setHasNext(java.lang.Boolean value)
public java.lang.Integer getPageSize()
public void setPageSize(java.lang.Integer value)
public java.lang.String getScrollId()
public void setScrollId(java.lang.String value)
public java.lang.Integer getTotalCount()
public void setTotalCount(java.lang.Integer value)
public ContactDataList getContactData()
public void setContactData(ContactDataList 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 |