CommentQuery (Ametys 4.4.x - API)

java.lang.Object
- org.ametys.cms.search.query.CommentQuery

All Implemented Interfaces:

Query
```
public class CommentQuery
extends Object
implements Query
```
Represents a Query testing if contents have comments.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CommentQuery.CommentInclusion
The type (validated, non validated or both) of comments to include for CommentQuery
- Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query
  Query.LogicalOperator, Query.Operator

Field Summary

Fields
Modifier and Type Field Description

private CommentQuery.CommentInclusion _commentInclusion

private Query.Operator _operator

Constructor Summary

Constructors
Constructor Description

CommentQuery(CommentQuery.CommentInclusion commentInclusion, Query.Operator operator)
Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`build()`	Build the solr query string representing the Query object.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`

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

Methods inherited from interface org.ametys.cms.search.query.Query
toString

- Field Detail
  - _commentInclusion
```
private CommentQuery.CommentInclusion _commentInclusion
```
  - _operator
```
private Query.Operator _operator
```
- Constructor Detail
  - CommentQuery
```
public CommentQuery(CommentQuery.CommentInclusion commentInclusion,
                    Query.Operator operator)
```
    Constructor
    
    Parameters:
    
    commentInclusion - The type of comments to include in search (request only contents with validated comments, or only contents with non validated comments, or both)
    
    operator - The operator. Only Query.Operator.EQ and Query.Operator.NE are allowed.
- Method Detail
  - build
```
public String build()
             throws QuerySyntaxException
```
    Description copied from interface: Query
    
    Build the solr query string representing the Query object.
    
    Specified by:
    
    build in interface Query
    
    Returns:
    
    the solr query string representing the Query object.
    
    Throws:
    
    QuerySyntaxException - if the query can't be built because of a syntax error.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object