|
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.events.EventSearch
public final class EventSearch
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. |
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 |
---|
public static final int ID
public static final java.lang.String NAME
Constructor Detail |
---|
public EventSearch()
Method Detail |
---|
public static EventSearch create()
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 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 |