Platform SDK Java 8.5 API Reference

com.genesyslab.platform.webmedia.protocol.callback.events
Class EventSearchResult

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.webmedia.protocol.callback.events.EventSearchResult
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventSearchResult
extends Message

Creates a search results packet that can contain information on one or more callback requests. The nested SearchResult class contains information about the individual requests that met the search criteria.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventSearchResult create()
          Creates instance of EventSearchResult with no parameters set.
static EventSearchResult create(SearchResultList searchResultList)
          Creates instance of EventSearchResult with all parameters set.
abstract  java.lang.Integer getReferenceId()
          An integer that provides a unique identifier for each request or event message.
abstract  SearchResultList getSearchResultList()
          Contains information about requests that match search criteria in the EventSearchResult event.
abstract  void setReferenceId(int referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setReferenceId(java.lang.Integer referenceId)
          An integer that provides a unique identifier for each request or event message.
abstract  void setSearchResultList(SearchResultList searchResultList)
          Contains information about requests that match search criteria in the EventSearchResult event.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

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
Method Detail

create

public static EventSearchResult create()
Creates instance of EventSearchResult with no parameters set.

Returns:
instance of EventSearchResult

create

public static EventSearchResult create(SearchResultList searchResultList)
Creates instance of EventSearchResult with all parameters set.

Parameters:
searchResultList - SearchResultList
Returns:
instance of EventSearchResult

getReferenceId

public abstract java.lang.Integer getReferenceId()
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
An integer that provides a unique identifier for each request or event message.


setReferenceId

public abstract void setReferenceId(int referenceId)
An integer that provides a unique identifier for each request or event message.


getSearchResultList

public abstract SearchResultList getSearchResultList()
Contains information about requests that match search criteria in the EventSearchResult event.


setSearchResultList

public abstract void setSearchResultList(SearchResultList searchResultList)
Contains information about requests that match search criteria in the EventSearchResult event.


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.