Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.events
Class EventContactListGet

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
              extended by com.genesyslab.platform.contacts.protocol.contactserver.events.EventContactListGet
All Implemented Interfaces:
EndpointSupport, ProtocolDescriptionSupport, Referenceable, com.genesyslab.platform.commons.protocol.runtime.DataSupport, com.genesyslab.platform.commons.protocol.runtime.UpdatableProtocolId, ContactServerMessage, Printable, RequestorInfoSupport

public final class EventContactListGet
extends AbstractMessage

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.

Related Requests:
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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Constructor Detail

EventContactListGet

public EventContactListGet()
Method Detail

create

public static EventContactListGet create()

getHasNext

public java.lang.Boolean getHasNext()
Indicates more records are available (using RequestContactListGetNextPage).


setHasNext

public void setHasNext(java.lang.Boolean value)
Indicates more records are available (using RequestContactListGetNextPage).


getPageSize

public java.lang.Integer getPageSize()
The number of Contacts available in this page.


setPageSize

public void setPageSize(java.lang.Integer value)
The number of Contacts available in this page.


getScrollId

public java.lang.String getScrollId()
This ID is used to call RequestContactListGetNextPage. Not available if HasNext is FALSE.


setScrollId

public void setScrollId(java.lang.String value)
This ID is used to call RequestContactListGetNextPage. Not available if HasNext is FALSE.


getTotalCount

public java.lang.Integer getTotalCount()
Present only if ContactCount=TRUE in the request.


setTotalCount

public void setTotalCount(java.lang.Integer value)
Present only if ContactCount=TRUE in the request.


getContactData

public ContactDataList getContactData()

setContactData

public void setContactData(ContactDataList value)

getMetaData

public com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()

getCustomPackagers

public java.util.List getCustomPackagers()
Specified by:
getCustomPackagers in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
Overrides:
getCustomPackagers in class AbstractMessage

attributes

public java.util.Map attributes()

getCompounds

public java.util.Map getCompounds()

createClone

public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)

hashCode

public int hashCode()
Overrides:
hashCode in class DataObject

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class DataObject

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.