TextSearchQuery (Atlassian Confluence 8.8.0 API)

java.lang.Object
- com.atlassian.confluence.search.v2.query.TextSearchQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery
```
@SearchPrimitive
public class TextSearchQuery
extends Object
implements SearchQuery
```
This query represents a text search on a Lucene field. The text search can be a complex expression such as {code}"Do it right" AND right{code}

Since:

7.20

Field Summary

Fields
Modifier and Type Field Description

static String KEY
- Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery
  DEFAULT_BOOST

Constructor Summary

Constructors
Constructor Description

TextSearchQuery(String fieldName, String query, BooleanOperator operator)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SearchQuery`	`expand()`	Expands this query into a composite query (that composes other queries).
`String`	`getFieldName()`
`String`	`getKey()`
`BooleanOperator`	`getOperator()`
`List<?>`	`getParameters()`	List of parameters as `String`s or `SearchQuery`s.
`String`	`getRawQuery()`
`String`	`getUnescapedQuery()`

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

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery
getBoost, getSubClauses

- Field Detail
  - KEY
```
public static final String KEY
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TextSearchQuery
```
public TextSearchQuery(String fieldName,
                       String query,
                       BooleanOperator operator)
```
- Method Detail
  - getKey
```
public String getKey()
```
    Specified by:
    
    getKey in interface SearchQuery
    
    Returns:
    
    the plugin key
  - getParameters
```
public List<?> getParameters()
```
    Description copied from interface: SearchQuery
    
    List of parameters as Strings or SearchQuerys.
    
    Specified by:
    
    getParameters in interface SearchQuery
    
    Returns:
    
    Strings or SearchQuerys.
  - expand
```
public SearchQuery expand()
```
    Description copied from interface: SearchQuery
    
    Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.
    
    Specified by:
    
    expand in interface Expandable<SearchQuery>
    
    Specified by:
    
    expand in interface SearchQuery
    
    Returns:
    
    a query
  - getFieldName
```
public String getFieldName()
```
  - getRawQuery
```
public String getRawQuery()
```
  - getUnescapedQuery
```
public String getUnescapedQuery()
```
  - getOperator
```
public BooleanOperator getOperator()
```