com.atlassian.user.search.query
Interface EntityQueryParser

public interface EntityQueryParser

Parses and executes queries for users and groups against one or more Atlassian-User repositories. Implementations generally support single-term and arbitrarily nested boolean queries for user and group properties.

Membership queries are not supported and have been officially deprecated as of Atlassian-User 2.1.

See Also:

Query, UserQuery, GroupQuery

Method Summary

SearchResult<Group>	findGroups(Query<Group> query) Returns the groups matching the provided query.
SearchResult<Group>	findGroups(Query<Group> query, QueryContext context) If the repository matches the query context, returns the groups matching the query, otherwise returns null.
SearchResult<User>	findUsers(Query<User> query) Returns the users matching the provided query.
SearchResult<User>	findUsers(Query<User> query, QueryContext context) If the repository matches the query context, returns the users matching the query, otherwise returns null.

Method Detail

findUsers

SearchResult<User> findUsers(Query<User> query)
                             throws EntityException

Returns the users matching the provided query.

Throws:

EntityQueryException - if the query is a boolean query constructed from different term types

java.lang.IllegalArgumentException - if the query is a membership query

EntityException - is there is a problem performing the query (e.g. database connection failure)

findGroups

SearchResult<Group> findGroups(Query<Group> query)
                               throws EntityException

Returns the groups matching the provided query.

Throws:

EntityQueryException - if the query is a boolean query constructed from different term types

java.lang.IllegalArgumentException - if the query is a membership query

EntityException - is there is a problem performing the query (e.g. database connection failure)

findUsers

SearchResult<User> findUsers(Query<User> query,
                             QueryContext context)
                             throws EntityException

If the repository matches the query context, returns the users matching the query, otherwise returns null.

Throws:

EntityQueryException - if the query is a boolean query constructed from different term types

java.lang.IllegalArgumentException - if the query is a membership query

EntityException - is there is a problem performing the query (e.g. database connection failure)

findGroups

SearchResult<Group> findGroups(Query<Group> query,
                               QueryContext context)
                               throws EntityException

If the repository matches the query context, returns the groups matching the query, otherwise returns null.

Throws:

EntityQueryException - if the query is a boolean query constructed from different term types

java.lang.IllegalArgumentException - if the query is a membership query

EntityException - is there is a problem performing the query (e.g. database connection failure)