Platform SDK Java 8.5 API Reference

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

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.RequestGetContacts
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 RequestGetContacts
extends AbstractMessage

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.

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

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

RequestGetContacts

public RequestGetContacts()
Method Detail

create

public static RequestGetContacts 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.


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.


getContactCount

public java.lang.Boolean getContactCount()
Asks UCS to return total count of matching Contacts. Setting this parameter to TRUE results in an extra database query which will decrease performance. Default value: False.


setContactCount

public void setContactCount(java.lang.Boolean value)
Asks UCS to return total count of matching Contacts. Setting this parameter to TRUE results in an extra database query which will decrease performance. Default value: False.


getAttributeList

public StringList getAttributeList()

setAttributeList

public void setAttributeList(StringList value)

getSearchCriteria

public SearchCriteriaCollection getSearchCriteria()

setSearchCriteria

public void setSearchCriteria(SearchCriteriaCollection value)

getSortCriteria

public SortCriteriaCollection getSortCriteria()

setSortCriteria

public void setSortCriteria(SortCriteriaCollection value)

getIndexOfFirst

public java.lang.Integer getIndexOfFirst()
Index of the first row in selection. Default value: 0.


setIndexOfFirst

public void setIndexOfFirst(java.lang.Integer value)
Index of the first row in selection. Default value: 0.


getMaxCount

public java.lang.Integer getMaxCount()
Maximum number of rows in selection.


setMaxCount

public void setMaxCount(java.lang.Integer value)
Maximum number of rows in selection.


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.