Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.events
Class EventInteractionListGet

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.events.EventInteractionListGet
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 EventInteractionListGet
extends AbstractMessage

This event returns a list of Interactions matching the criteria specified by RequestInteractionListGet.

Selected Properties:

Name Description
getPageSize() The number of Contacts available in this page.
getHasNext() Indicates whether more records are available.

Related Requests:
Name Description
RequestInteractionListGet This request provides a list of Interactions that you can scroll through. The request can be filtered by specifying constraints, or sorted using specified criteria.


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
EventInteractionListGet()
           
 
Method Summary
 java.util.Map attributes()
           
static EventInteractionListGet 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.Boolean getHasNext()
          Indicates whether more interaction records are available in the list.
 InteractionDataList getInteractionData()
          A key-value list containing the attributes (as specified in RequestInteractionListGet) for the current interaction in the returned list.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Integer getPageSize()
          The number of interactions available in this page.
 java.lang.String getScrollId()
          This ID is used to specify the next page of the list.
 int hashCode()
           
 void setHasNext(java.lang.Boolean value)
          Indicates whether more interaction records are available in the list.
 void setInteractionData(InteractionDataList value)
          A key-value list containing the attributes (as specified in RequestInteractionListGet) for the current interaction in the returned list.
 void setPageSize(java.lang.Integer value)
          The number of interactions available in this page.
 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

EventInteractionListGet

public EventInteractionListGet()
Method Detail

create

public static EventInteractionListGet create()

getHasNext

public java.lang.Boolean getHasNext()
Indicates whether more interaction records are available in the list. UCS automatically closes and releases the list once this value is FALSE.


setHasNext

public void setHasNext(java.lang.Boolean value)
Indicates whether more interaction records are available in the list. UCS automatically closes and releases the list once this value is FALSE.


getPageSize

public java.lang.Integer getPageSize()
The number of interactions available in this page.


setPageSize

public void setPageSize(java.lang.Integer value)
The number of interactions available in this page.


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".


getInteractionData

public InteractionDataList getInteractionData()
A key-value list containing the attributes (as specified in RequestInteractionListGet) for the current interaction in the returned list. To view attributes for another interaction, use RequestInteractionListGetNext.


setInteractionData

public void setInteractionData(InteractionDataList value)
A key-value list containing the attributes (as specified in RequestInteractionListGet) for the current interaction in the returned list. To view attributes for another interaction, use RequestInteractionListGetNext.


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.