Platform SDK Java 8.5 API Reference

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

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

This event returns a list of UCS documents — standard responses, contacts, or interactions — that match the string-based queries submitted in RequestSearch.

Note: This type of search is not done in UCS database, so the results cannot be used to update UCS documents. Once a desired UCS document is identified using this request, then a query must be sent to the DB to process any desired updates.

Selected Properties:

Name Description
getFoundDocuments() The total number of matching documents.
setReturnedDocuments(java.lang.Integer) The number of documents returned.

Related Requests:
Name Description
RequestSearch This request provides the ability to search for UCS entries - standard responses, contacts, or interactions - that match the string-based queries you create.

Search results rely on the UCS indexing service, which can be configured to parse and index the content of UCS entries. UCS indexing should be scheduled for off-hours, and should be event-based indexing so that modified properties will be re-indexed.

You can use RequestGetIndexProperties to create a list of key field names that are searchable.



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
EventSearch()
           
 
Method Summary
 java.util.Map attributes()
           
static EventSearch 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()
           
 DocumentList getDocuments()
          A key-value list containing an ordered set of UCS documents that were returned with this event.
 java.lang.Integer getFoundDocuments()
          The total number of matching documents found in UCS.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 java.lang.Integer getReturnedDocuments()
          The number of documents returned with this event.
 int hashCode()
           
 void setDocuments(DocumentList value)
          A key-value list containing an ordered set of UCS documents that were returned with this event.
 void setFoundDocuments(java.lang.Integer value)
          The total number of matching documents found in UCS.
 void setReturnedDocuments(java.lang.Integer value)
          The number of documents returned with this event.
 
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

EventSearch

public EventSearch()
Method Detail

create

public static EventSearch create()

getFoundDocuments

public java.lang.Integer getFoundDocuments()
The total number of matching documents found in UCS.


setFoundDocuments

public void setFoundDocuments(java.lang.Integer value)
The total number of matching documents found in UCS.


getReturnedDocuments

public java.lang.Integer getReturnedDocuments()
The number of documents returned with this event.


setReturnedDocuments

public void setReturnedDocuments(java.lang.Integer value)
The number of documents returned with this event.


getDocuments

public DocumentList getDocuments()
A key-value list containing an ordered set of UCS documents that were returned with this event.


setDocuments

public void setDocuments(DocumentList value)
A key-value list containing an ordered set of UCS documents that were returned with this event.


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.