QueryRequest (ddc-core 7.4.0.0.0.0 API)

java.lang.Object
- com.imperva.ddc.core.query.Request
- - com.imperva.ddc.core.query.QueryRequest

All Implemented Interfaces:

AutoCloseable
```
public class QueryRequest
extends Request
```
Created by gabi.beyo on 18/06/2015.

Constructor Summary

Constructors
Constructor and Description

QueryRequest()

Constructors
Constructor and Description
`QueryRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryRequest`	`addEndpoint(Endpoint endpoint)` Helper function used for adding `Endpoint` in a fluent coding style instead of using setEndpoints
`QueryRequest`	`addRequestedField(FieldType fieldType)` Helper function used for adding requested fields `Field` by field-type in a fluent coding style instead of using setRequestedField
`QueryRequest`	`addRequestedField(String fieldName)` Helper function used for adding requested fields `Field` by field-name in a fluent coding style instead of using setRequestedField
`void`	`addSearchSentence(Sentence searchSentences)`
`SortKey`	`addSortKey(FieldType fieldType)`
`SortKey`	`addSortKey(String name)`
`void`	`close()`
`Word`	`find(String id)` Both `Sentence` and `Phrase` extends from `Word`.
`List<Endpoint>`	`getEndpoints()`
`ObjectType`	`getObjectType()`
`int`	`getPageChunkSize()`
`ReferralsHandling`	`getReferralsHandling()`
`List<Field>`	`getRequestedFields()`
`Sentence`	`getSearchSentence()`
`String`	`getSearchSentenceText()`
`String`	`getSearchText()`
`Integer`	`getSizeLimit()`
`List<SortKey>`	`getSortKeys()`
`Integer`	`getTimeLimit()`
`boolean`	`isPaged()`
`void`	`setEndpoints(List<Endpoint> endpoints)`
`void`	`setObjectType(ObjectType objectType)`
`void`	`setPageChunkSize(int pageChunkSize)`
`void`	`setReferralsHandling(ReferralsHandling referralsHandling)`
`void`	`setRequestedFields(List<Field> fields)`
`void`	`setSearchSentence(Sentence searchSentences)`
`void`	`setSearchSentenceText(String searchSentenceText)`
`void`	`setSearchText(String searchText)`
`void`	`setSizeLimit(Integer sizeLimit)`
`void`	`setTimeLimit(Integer timeLimit)`

Methods inherited from class com.imperva.ddc.core.query.Request
getDirectoryType, isIgnoreSSLValidations, setDirectoryType, setIgnoreSSLValidations

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - QueryRequest
```
public QueryRequest()
```
- Method Detail
  - getPageChunkSize
```
public int getPageChunkSize()
```
    Returns:
    
    Used in Paged scenarios, specify the max chunk size of each roundtrip
  - setPageChunkSize
```
public void setPageChunkSize(int pageChunkSize)
```
    Parameters:
    
    pageChunkSize - Used in Paged scenarios, specify the max chunk size of each roundtrip
  - setObjectType
```
public void setObjectType(ObjectType objectType)
```
    Parameters:
    
    objectType - A ObjectType which indicates the requested object to search
  - getObjectType
```
public ObjectType getObjectType()
```
    Returns:
    
    A ObjectType which indicates the requested object to search
  - setRequestedFields
```
public void setRequestedFields(List<Field> fields)
```
    Parameters:
    
    fields - A list of Field used to indicate the requested field per object to retrieve When not specified the query will return as result all the available attributes
  - getRequestedFields
```
public List<Field> getRequestedFields()
```
    Returns:
    
    A list of Field used to indicate the requested field per object to retrieve When not specified the query will return as result all the available attributes
  - setSearchSentence
```
public void setSearchSentence(Sentence searchSentences)
```
    Parameters:
    
    searchSentences - A Sentence which express part of the query
  - getSearchSentence
```
public Sentence getSearchSentence()
```
    Returns:
    
    A Sentence which express part of the query
  - getSearchText
```
public String getSearchText()
```
    Returns:
    
    Free style search, when exist overrides Sentence and Phrase representation
  - setSearchText
```
public void setSearchText(String searchText)
```
    Parameters:
    
    searchText - Free style search, when exist overrides Sentences and Phrases
  - getSearchSentenceText
```
public String getSearchSentenceText()
```
    Returns:
    
    The final search text translated by DDC from objects representation i.e Sentence and Phrase
  - setSearchSentenceText
```
public void setSearchSentenceText(String searchSentenceText)
```
    Parameters:
    
    searchSentenceText - The final search text translated by DDC from objects representation i.e Sentence and Phrase
  - getEndpoints
```
public List<Endpoint> getEndpoints()
```
    Returns:
    
    List of Endpoint, used in multi forest scenario
  - setEndpoints
```
public void setEndpoints(List<Endpoint> endpoints)
```
    Parameters:
    
    endpoints - List of Endpoint, used in multi forest scenario
  - getReferralsHandling
```
public ReferralsHandling getReferralsHandling()
```
    Returns:
    
    A ReferralsHandling which dictates the way to handle Referrals
  - setReferralsHandling
```
public void setReferralsHandling(ReferralsHandling referralsHandling)
```
    Parameters:
    
    referralsHandling - A ReferralsHandling which dictates the way to handle Referrals
  - getSizeLimit
```
public Integer getSizeLimit()
```
    Returns:
    
    Maximum number of entries to retrieve
  - setSizeLimit
```
public void setSizeLimit(Integer sizeLimit)
```
    Parameters:
    
    sizeLimit - Maximum number of entries to retrieve
  - getTimeLimit
```
public Integer getTimeLimit()
```
    Returns:
    
    Maximum time to wait for a response from the server (in seconds). A value of 0 in this field indicates that no client-requested time-limit restrictions are in effect for the search.
  - setTimeLimit
```
public void setTimeLimit(Integer timeLimit)
```
    Parameters:
    
    timeLimit - Maximum time to wait for a response from the server (in seconds). A value of 0 in this field indicates that no client-requested time-limit restrictions are in effect for the search.
  - addRequestedField
```
public QueryRequest addRequestedField(String fieldName)
```
    Helper function used for adding requested fields Field by field-name in a fluent coding style instead of using setRequestedField
    
    Parameters:
    
    fieldName - A string which indicates the name of the added field
    
    Returns:
  - addRequestedField
```
public QueryRequest addRequestedField(FieldType fieldType)
```
    Helper function used for adding requested fields Field by field-type in a fluent coding style instead of using setRequestedField
    
    Parameters:
    
    fieldType - A FieldType which indicates the type of the added field
    
    Returns:
  - isPaged
```
public boolean isPaged()
```
    Returns:
    
    return true if request isa Paged request, otherwise false
  - addEndpoint
```
public QueryRequest addEndpoint(Endpoint endpoint)
```
    Helper function used for adding Endpoint in a fluent coding style instead of using setEndpoints
    
    Parameters:
    
    endpoint - A Endpoint objects
    
    Returns:
  - addSearchSentence
```
public void addSearchSentence(Sentence searchSentences)
```
    Parameters:
    
    searchSentences - A Sentence append new Sentence if other Sentences exist, otherwise set as first Sentence
  - find
```
public Word find(String id)
```
    Both Sentence and Phrase extends from Word. This function is used in cases where there is a need to keep track of specific Sentence or Phrase
    
    Parameters:
    
    id - Word identifier
    
    Returns:
    
    Requested Word object if found, otherwise null
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class Request
  - getSortKeys
```
public List<SortKey> getSortKeys()
```
    Returns:
    
    Get the sort keys (attributes) to sort the result on
  - addSortKey
```
public SortKey addSortKey(FieldType fieldType)
```
  - addSortKey
```
public SortKey addSortKey(String name)
```

Class QueryRequest

Constructor Summary

Method Summary

Methods inherited from class com.imperva.ddc.core.query.Request

Methods inherited from class java.lang.Object

Constructor Detail

QueryRequest

Method Detail

getPageChunkSize

setPageChunkSize

setObjectType

getObjectType

setRequestedFields

getRequestedFields

setSearchSentence

getSearchSentence

getSearchText

setSearchText

getSearchSentenceText

setSearchSentenceText

getEndpoints

setEndpoints

getReferralsHandling

setReferralsHandling

getSizeLimit

setSizeLimit

getTimeLimit

setTimeLimit

addRequestedField

addRequestedField

isPaged

addEndpoint

addSearchSentence

find

close

getSortKeys

addSortKey

addSortKey