EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class EventSearch extends AbstractMessage
Name | Description |
---|---|
getFoundDocuments() |
The total number of matching documents. |
setReturnedDocuments(java.lang.Integer) |
The number of documents returned. |
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. |
Modifier and Type | Field | Description |
---|---|---|
static int |
ID |
|
static java.lang.String |
NAME |
REF_ID_KEY
Constructor | Description |
---|---|
EventSearch() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static EventSearch |
create() |
|
DataSupport |
createClone(DataSupport sample) |
|
Message |
createEspMessage() |
For internal usage only
|
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.
|
java.lang.String |
getMessageCategory() |
For internal usage only
|
MetaData |
getMetaData() |
|
java.lang.String |
getMethod() |
For internal usage only
|
java.lang.String |
getMethodKey() |
For internal usage only
|
java.lang.Integer |
getReturnedDocuments() |
The number of documents returned with this event.
|
java.lang.String |
getService() |
For internal usage only
|
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.
|
getEndpoint, getLazyParser, getMessageAttribute, getProtocolId, getReferenceId, getRequestorInfo, retreiveReference, setEndpoint, setProtocolId, setReferenceId, setReferenceId, setRequestorInfo, toString, toString, toString, toString, updateReference
cloneMessage, getProtocolDescription, messageId, messageName, setProtocolDescription
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static EventSearch create()
public java.lang.String getMethodKey()
AbstractMessage
getMethodKey
in class AbstractMessage
public java.lang.String getService()
AbstractMessage
getService
in class AbstractMessage
public java.lang.String getMethod()
AbstractMessage
getMethod
in class AbstractMessage
public java.lang.String getMessageCategory()
AbstractMessage
getMessageCategory
in class AbstractMessage
public Message createEspMessage()
AbstractMessage
createEspMessage
in class AbstractMessage
public java.lang.Integer getFoundDocuments()
public void setFoundDocuments(java.lang.Integer value)
public java.lang.Integer getReturnedDocuments()
public void setReturnedDocuments(java.lang.Integer value)
public DocumentList getDocuments()
public void setDocuments(DocumentList value)
public MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public DataSupport createClone(DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.