EndpointSupport
, ProtocolDescriptionSupport
, Referenceable
, DataSupport
, ContactServerMessage
, Printable
, RequestorInfoSupport
public final class RequestSearch extends AbstractMessage
Name | Description |
---|---|
setIndexName(java.lang.String) |
Identifies the object that needs to be queried in UCS indexing service. |
setQuery(java.lang.String) |
Defines the query to be processed. |
Name | Description |
---|---|
EventSearch |
This event returns a list of UCS documents — standard responses, contacts, or interactions — that match the string-based queries submitted in RequestSearch. |
EventError |
Indicates that the request encountered an error. |
Modifier and Type | Field | Description |
---|---|---|
static int |
ID |
|
static java.lang.String |
NAME |
REF_ID_KEY
Constructor | Description |
---|---|
RequestSearch() |
Modifier and Type | Method | Description |
---|---|---|
java.util.Map |
attributes() |
|
static RequestSearch |
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() |
|
java.lang.String |
getDefaultFields() |
String value that specifies one or more default fields to search.
|
java.lang.String |
getIndexName() |
String value that identifies the index that you want to query in the UCS indexing service.
|
java.lang.Integer |
getMaxResults() |
Maximum number of returned documents.
|
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.String |
getQuery() |
Defines the query to be processed.
|
java.lang.String |
getService() |
For internal usage only
|
java.lang.String |
getSubscriberId() |
The subscriber (i.e. customer) within the tenant to which the document should belong to.
|
java.lang.Integer |
getTenantId() |
The TenantId.
|
int |
hashCode() |
|
void |
setDefaultFields(java.lang.String value) |
String value that specifies one or more default fields to search.
|
void |
setIndexName(java.lang.String value) |
String value that identifies the index that you want to query in the UCS indexing service.
|
void |
setMaxResults(java.lang.Integer value) |
Maximum number of returned documents.
|
void |
setQuery(java.lang.String value) |
Defines the query to be processed.
|
void |
setSubscriberId(java.lang.String value) |
The subscriber (i.e. customer) within the tenant to which the document should belong to.
|
void |
setTenantId(java.lang.Integer value) |
The TenantId.
|
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 RequestSearch 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.String getIndexName()
public void setIndexName(java.lang.String value)
public java.lang.Integer getMaxResults()
public void setMaxResults(java.lang.Integer value)
public java.lang.String getSubscriberId()
public void setSubscriberId(java.lang.String value)
public java.lang.Integer getTenantId()
public void setTenantId(java.lang.Integer value)
public java.lang.String getQuery()
public void setQuery(java.lang.String value)
public java.lang.String getDefaultFields()
public void setDefaultFields(java.lang.String 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.