AbstractUsersQuery (Ametys 4.5.x - API)

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

All Implemented Interfaces:: Query

public abstract class AbstractUsersQuery
extends Object
implements Query

Query testing users.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query
  Query.LogicalOperator, Query.Operator

Constructor Summary

Constructors
Constructor	Description
`AbstractUsersQuery(Collection<UserIdentity> users)`	Build a user query.
`AbstractUsersQuery(Collection<UserIdentity> users, Query.Operator operator)`	Build a user query.
`AbstractUsersQuery(UserIdentity... users)`	Build a user query.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`build()`	Build the solr query string representing the Query object.
`boolean`	`equals(Object obj)`
`protected abstract String`	`getField()`	The query field.
`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

- Constructor Detail
  - AbstractUsersQuery
```
public AbstractUsersQuery(UserIdentity... users)
```
    Build a user query.
    
    Parameters:
    
    users - The users to test.
  - AbstractUsersQuery
```
public AbstractUsersQuery(Collection<UserIdentity> users)
```
    Build a user query.
    
    Parameters:
    
    users - The users to test.
  - AbstractUsersQuery
```
public AbstractUsersQuery(Collection<UserIdentity> users,
                          Query.Operator operator)
```
    Build a user query.
    
    Parameters:
    
    users - The users to test.
    
    operator - The query operator (can be EQ or NE).
- 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
  - getField
```
protected abstract String getField()
```
    The query field.
    
    Returns:
    
    The query field.