|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.contacts.protocol.contactserver.AbstractMessage
com.genesyslab.platform.contacts.protocol.contactserver.requests.RequestSearch
public final class 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.
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.
Required parameters:
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. |
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 | |
---|---|
RequestSearch()
|
Method Summary | |
---|---|
java.util.Map |
attributes()
|
static RequestSearch |
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.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. |
com.genesyslab.platform.commons.protocol.runtime.MetaData |
getMetaData()
|
java.lang.String |
getQuery()
Defines the query to be processed. |
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. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public RequestSearch()
Method Detail |
---|
public static RequestSearch create()
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 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
public java.util.List getCustomPackagers()
getCustomPackagers
in interface com.genesyslab.platform.commons.protocol.runtime.DataSupport
getCustomPackagers
in class AbstractMessage
public java.util.Map attributes()
public java.util.Map getCompounds()
public com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
public int hashCode()
hashCode
in class DataObject
public boolean equals(java.lang.Object obj)
equals
in class DataObject
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |