org.ametys.cms.search.query

Class UsersQuery

java.lang.Object

org.ametys.cms.search.query.AbstractFieldQuery

org.ametys.cms.search.query.UsersQuery

All Implemented Interfaces:

Query

Direct Known Subclasses:

AclReadAllowedUsersQuery, AclReadDeniedUsersQuery

public class UsersQuery
extends AbstractFieldQuery

Query testing users.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields

Modifier and Type	Field and Description
private Query.Operator	_operator
private Collection<UserIdentity>	_users

Fields inherited from class org.ametys.cms.search.query.AbstractFieldQuery

_fieldPath

Constructor Summary

Constructors

Constructor and Description
UsersQuery(String fieldPath, Collection<UserIdentity> users) Build a user query.
UsersQuery(String fieldPath, Query.Operator operator, Collection<UserIdentity> users) Build a user query.
UsersQuery(String fieldPath, Query.Operator operator, UserIdentity... users) Build a user query.
UsersQuery(String fieldPath, UserIdentity... users) Build a user query.

Method Summary

Modifier and Type	Method and Description
String	build() Build the solr query string representing the Query object.

Methods inherited from class org.ametys.cms.search.query.AbstractFieldQuery

getFieldPath

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_users

private Collection<UserIdentity> _users

_operator

private Query.Operator _operator

Constructor Detail

UsersQuery

public UsersQuery(String fieldPath,
                  UserIdentity... users)

Build a user query.

Parameters:

fieldPath - the field's path

users - The users to test.

UsersQuery

public UsersQuery(String fieldPath,
                  Collection<UserIdentity> users)

Build a user query.

Parameters:

fieldPath - the field's path

users - The users to test.

UsersQuery

public UsersQuery(String fieldPath,
                  Query.Operator operator,
                  UserIdentity... users)

Build a user query.

Parameters:

fieldPath - the field's path

operator - The query operator (can be EQ or NE).

users - The users to test.

UsersQuery

public UsersQuery(String fieldPath,
                  Query.Operator operator,
                  Collection<UserIdentity> users)

Build a user query.

Parameters:

fieldPath - the field's path

operator - The query operator (can be EQ or NE).

users - The users to test.

Method Detail

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.