Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestContactListGet

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.requests.RequestContactListGet
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 RequestContactListGet
extends AbstractMessage

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.

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

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

RequestContactListGet

public RequestContactListGet()
Method Detail

create

public static RequestContactListGet create()

getTenantId

public java.lang.Integer getTenantId()

setTenantId

public void setTenantId(java.lang.Integer value)

getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. line of business) within the tenant to which the contacts belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. line of business) within the tenant to which the contacts belong to.


getContactCount

public java.lang.Boolean getContactCount()
Total count of matching Contacts.


setContactCount

public void setContactCount(java.lang.Boolean value)
Total count of matching Contacts.


getRestricted

public java.lang.Boolean getRestricted()
If TRUE, filtering uses primary sortable attributes (Contact table), if FALSE, filtering uses all attributes (ContactAttribute table). Default value: False.


setRestricted

public void setRestricted(java.lang.Boolean value)
If TRUE, filtering uses primary sortable attributes (Contact table), if FALSE, filtering uses all attributes (ContactAttribute table). Default value: False.


getPageMaxSize

public java.lang.Integer getPageMaxSize()
If no value is provided, UCS configured value (settings/max-select-count) is used.


setPageMaxSize

public void setPageMaxSize(java.lang.Integer value)
If no value is provided, UCS configured value (settings/max-select-count) is used.


getAttributeList

public StringList getAttributeList()
List of sortable attributes to return. If AttributeList KVList is null or is not passed, all attributes are returned.


setAttributeList

public void setAttributeList(StringList value)
List of sortable attributes to return. If AttributeList KVList is null or is not passed, all attributes are returned.


getSearchCriteria

public SearchCriteriaCollection getSearchCriteria()
No filtering if not present.


setSearchCriteria

public void setSearchCriteria(SearchCriteriaCollection value)
No filtering if not present.


getSortCriteria

public SortCriteriaCollection getSortCriteria()
No ordering if not present.


setSortCriteria

public void setSortCriteria(SortCriteriaCollection value)
No ordering if not present.


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.