Platform SDK Java 8.5 API Reference

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

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

This request is intended for delivering the next portion of the contact objects, previously found by some constraints. Request provides unidirectional scrolling of selected contacts, no backward scrolling or jumping to the record with arbitrary number.

Required parameters:

Name Description
setScrollId(java.lang.String) Identifies the existing ScrollableList object for which RequestContactListGetNextPage should be applied

Related Events:
Name Description
EventContactListGetNextPage This event returns the next page of contact objects, as specified by the earlier constraints. This event does not provide backward scrolling or jumping to an arbitrary number in the contact list.
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
RequestContactListGetNextPage()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestContactListGetNextPage 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()
           
 java.util.List getCustomPackagers()
           
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Integer getPageMaxSize()
          Maximum size for the page of data, calculated as the minimum between the PageMaxSize property and the UCS internal limit.
 java.lang.String getScrollId()
          Identifies the existing ScrollableList object for which RequestContactListGetNextPage should be applied.
 int hashCode()
           
 void setPageMaxSize(java.lang.Integer value)
          Maximum size for the page of data, calculated as the minimum between the PageMaxSize property and the UCS internal limit.
 void setScrollId(java.lang.String value)
          Identifies the existing ScrollableList object for which RequestContactListGetNextPage should be applied.
 
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

RequestContactListGetNextPage

public RequestContactListGetNextPage()
Method Detail

create

public static RequestContactListGetNextPage create()

getPageMaxSize

public java.lang.Integer getPageMaxSize()
Maximum size for the page of data, calculated as the minimum between the PageMaxSize property and the UCS internal limit.


setPageMaxSize

public void setPageMaxSize(java.lang.Integer value)
Maximum size for the page of data, calculated as the minimum between the PageMaxSize property and the UCS internal limit.


getScrollId

public java.lang.String getScrollId()
Identifies the existing ScrollableList object for which RequestContactListGetNextPage should be applied.


setScrollId

public void setScrollId(java.lang.String value)
Identifies the existing ScrollableList object for which RequestContactListGetNextPage should be applied.


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.