Platform SDK Java 8.5 API Reference

com.genesyslab.platform.contacts.protocol.contactserver.requests
Class RequestSearch

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.requests.RequestSearch
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 RequestSearch
extends AbstractMessage

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.

Related Events:
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

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

RequestSearch

public RequestSearch()
Method Detail

create

public static RequestSearch create()

getIndexName

public java.lang.String getIndexName()
String value that identifies the index that you want to query in the UCS indexing service. Index values are customizable, so use RequestGetIndexProperties to check field names that are searchable.


setIndexName

public void setIndexName(java.lang.String value)
String value that identifies the index that you want to query in the UCS indexing service. Index values are customizable, so use RequestGetIndexProperties to check field names that are searchable.


getMaxResults

public java.lang.Integer getMaxResults()
Maximum number of returned documents.


setMaxResults

public void setMaxResults(java.lang.Integer value)
Maximum number of returned documents.


getSubscriberId

public java.lang.String getSubscriberId()
The subscriber (i.e. customer) within the tenant to which the document should belong to.


setSubscriberId

public void setSubscriberId(java.lang.String value)
The subscriber (i.e. customer) within the tenant to which the document should belong to.


getTenantId

public java.lang.Integer getTenantId()
The TenantId.


setTenantId

public void setTenantId(java.lang.Integer value)
The TenantId.


getQuery

public java.lang.String getQuery()
Defines the query to be processed. For details about creating queries, please check the Apache Lucene website (http://lucene.apache.org/core/) and refer to the Query Parser Syntax documentation provided there.


setQuery

public void setQuery(java.lang.String value)
Defines the query to be processed. For details about creating queries, please check the Apache Lucene website (http://lucene.apache.org/core/) and refer to the Query Parser Syntax documentation provided there.


getDefaultFields

public java.lang.String getDefaultFields()
String value that specifies one or more default fields to search. If this parameter is set, then any string specified in the Query parameter will automatically be searched for in every field specified here.

For example, using a Query of "EmailAddress:john OR FirstName:john" (with DefaultFields left empty) is the same as using a Query of "john" with DefaultFields set to "EmailAddress,FirstName".


setDefaultFields

public void setDefaultFields(java.lang.String value)
String value that specifies one or more default fields to search. If this parameter is set, then any string specified in the Query parameter will automatically be searched for in every field specified here.

For example, using a Query of "EmailAddress:john OR FirstName:john" (with DefaultFields left empty) is the same as using a Query of "john" with DefaultFields set to "EmailAddress,FirstName".


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.