Platform SDK Java 8.5 API Reference

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

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.RequestBoostDocument
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 RequestBoostDocument
extends AbstractMessage

This request increases document priority towards requests. This can be used with SRL for example, in order to enable one SRL to have higher weight against others and thus returning first.

Required parameters:

Name Description
setIndexName(java.lang.String) The index name where this boost is applied.
setDocumentId(java.lang.String) The unique document ID.
setBoostFactor(java.lang.String) Floating point number that is passed as a string, indicating the factor to boost this document priority by.

Related Events:
Name Description
EventBoostDocument Indicates whether RequestBoostDocument was successful or not. A list of possible error codes is included below:
  • Error Code 950: Indexing is disabled (change configuration options).
  • Error Code 951: Index searching is disabled (change configuration options).
  • Error Code 952: Incorrect IndexName specified: '{0}'.
  • Error Code 954: Unable to search in index: '{0}'.
  • Error Code 955: Unable to find document '{0}' in index: '{1}'.
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
RequestBoostDocument()
           
 
Method Summary
 java.util.Map attributes()
           
static RequestBoostDocument create()
           
 com.genesyslab.platform.commons.protocol.runtime.DataSupport createClone(com.genesyslab.platform.commons.protocol.runtime.DataSupport sample)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getBoostFactor()
          A float number that is passed as a sting, indicating the priority.
 java.util.Map getCompounds()
           
 java.util.List getCustomPackagers()
           
 java.lang.String getDocumentId()
          String value containing the document name.
 java.lang.String getIndexName()
          String value containing a unique index for this request.
 com.genesyslab.platform.commons.protocol.runtime.MetaData getMetaData()
           
 int hashCode()
           
 void setBoostFactor(java.lang.String value)
          A float number that is passed as a sting, indicating the priority.
 void setDocumentId(java.lang.String value)
          String value containing the document name.
 void setIndexName(java.lang.String value)
          String value containing a unique index for this request.
 
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

RequestBoostDocument

public RequestBoostDocument()
Method Detail

create

public static RequestBoostDocument create()

getIndexName

public java.lang.String getIndexName()
String value containing a unique index for this request.


setIndexName

public void setIndexName(java.lang.String value)
String value containing a unique index for this request.


getDocumentId

public java.lang.String getDocumentId()
String value containing the document name.


setDocumentId

public void setDocumentId(java.lang.String value)
String value containing the document name.


getBoostFactor

public java.lang.String getBoostFactor()
A float number that is passed as a sting, indicating the priority. Higher values receive higher priority. The default value (if not returned during a Search request) is "1.0".


setBoostFactor

public void setBoostFactor(java.lang.String value)
A float number that is passed as a sting, indicating the priority. Higher values receive higher priority. The default value (if not returned during a Search request) is "1.0".


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.