Platform SDK Java 8.5 API Reference

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

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

This request is intended for delivering the next portion of the merge records from the previously built MergeList. Request provides unidirectional scrolling of selected records, no backward scrolling or jumping to the record with arbitrary number.

Required parameters:

Name Description
setMergeListId(java.lang.String) Identifies the existing MergeList object for which GetMergeListNextPage method should be applied.

Related Events:
Name Description
EventMergeListGetNextPage This event delivers the next portion of the merge records from the previously built MergeList. This event provides unidirectional scrolling of selected records, no backward scrolling or jumping to the record with arbitrary number.
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
RequestMergeListGetNextPage()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestMergeListGetNextPage 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()
           
 java.lang.String getMergeListId()
          Identifies the existing MergeList object for which RequestMergeListGetNextPage should be applied.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Integer getPageMaxSize()
          Max size for the page of data, calculated as min(PageMaxSize, UCS internal limit).
 int hashCode()
           
 void setMergeListId(java.lang.String value)
          Identifies the existing MergeList object for which RequestMergeListGetNextPage should be applied.
 void setPageMaxSize(java.lang.Integer value)
          Max size for the page of data, calculated as min(PageMaxSize, UCS internal limit).
 
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

RequestMergeListGetNextPage

public RequestMergeListGetNextPage()
Method Detail

create

public static RequestMergeListGetNextPage create()

getMergeListId

public java.lang.String getMergeListId()
Identifies the existing MergeList object for which RequestMergeListGetNextPage should be applied.


setMergeListId

public void setMergeListId(java.lang.String value)
Identifies the existing MergeList object for which RequestMergeListGetNextPage should be applied.


getPageMaxSize

public java.lang.Integer getPageMaxSize()
Max size for the page of data, calculated as min(PageMaxSize, UCS internal limit).


setPageMaxSize

public void setPageMaxSize(java.lang.Integer value)
Max size for the page of data, calculated as min(PageMaxSize, UCS internal limit).


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.