Platform SDK Java 8.5 API Reference

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

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

This request scrolls to the next interaction in the list that was returned by EventInteractionListGet.

Required parameters:

Name Description
setScrollId(java.lang.String) Identifies the existing ScrollableList object to return the next page of.

Related Events:
Name Description
EventInteractionListGetNextPage This event returns the next interaction in the list that was returned by EventInteractionListGet.
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
RequestInteractionListGetNextPage()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestInteractionListGetNextPage 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()
          The maximum page size for interactions that are returned.
 java.lang.String getScrollId()
          This ID is used to specify the next page of the list.
 int hashCode()
           
 void setPageMaxSize(java.lang.Integer value)
          The maximum page size for interactions that are returned.
 void setScrollId(java.lang.String value)
          This ID is used to specify the next page of the list.
 
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

RequestInteractionListGetNextPage

public RequestInteractionListGetNextPage()
Method Detail

create

public static RequestInteractionListGetNextPage create()

getScrollId

public java.lang.String getScrollId()
This ID is used to specify the next page of the list. Not available if HasNext is "FALSE".


setScrollId

public void setScrollId(java.lang.String value)
This ID is used to specify the next page of the list. Not available if HasNext is "FALSE".


getPageMaxSize

public java.lang.Integer getPageMaxSize()
The maximum page size for interactions that are returned. If no value is provided, then the max-select-count parameter value (as configured in the UCS Application object) is used.


setPageMaxSize

public void setPageMaxSize(java.lang.Integer value)
The maximum page size for interactions that are returned. If no value is provided, then the max-select-count parameter value (as configured in the UCS Application object) is used.


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.