com.atlassian.confluence.user
Interface SearchEntitiesManager

All Known Implementing Classes:

DefaultSearchEntitiesManager

public interface SearchEntitiesManager

Field Summary

static String	MATCH_ALL
static String	MATCH_ANY

Method Summary

com.atlassian.user.search.query.Query	createUserQuery(List queries, String operator)
List	findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery) Find all groups matching a particular query.
List	findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery, boolean filterGroups) Find the groups that match a particular query, optionally filtering out groups not visible to the current user.
List	findUsersAsList(com.atlassian.user.search.query.Query finalQuery) Find all users matching a particular query.
com.atlassian.user.search.query.TermQuery	getGroupNameTermQuery(String groupnameTerm)
com.atlassian.user.search.query.TermQuery	getTermQuery(String term, Class termQueryClass)

Field Detail

MATCH_ALL

static final String MATCH_ALL

See Also:

Constant Field Values

MATCH_ANY

static final String MATCH_ANY

See Also:

Constant Field Values

Method Detail

getTermQuery

com.atlassian.user.search.query.TermQuery getTermQuery(String term,
                                                       Class termQueryClass)
                                                       throws com.atlassian.user.search.query.EntityQueryException

Throws:

com.atlassian.user.search.query.EntityQueryException

getGroupNameTermQuery

com.atlassian.user.search.query.TermQuery getGroupNameTermQuery(String groupnameTerm)
                                                                throws com.atlassian.user.search.query.EntityQueryException

Throws:

com.atlassian.user.search.query.EntityQueryException

createUserQuery

com.atlassian.user.search.query.Query createUserQuery(List queries,
                                                      String operator)
                                                      throws com.atlassian.user.search.query.EntityQueryException

Throws:

com.atlassian.user.search.query.EntityQueryException

findGroupsAsList

List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery)
                      throws com.atlassian.user.EntityException

Find all groups matching a particular query.

Parameters:

tQuery - the query to search on

Throws:

com.atlassian.user.EntityException

findGroupsAsList

List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery,
                      boolean filterGroups)
                      throws com.atlassian.user.EntityException

Find the groups that match a particular query, optionally filtering out groups not visible to the current user. The filterGroups argument will only make a difference if the Confluence server is running in shared mode.

Parameters:

tQuery - the query to search on

filterGroups - true will filter out groups the current user is not permitted to see

Throws:

com.atlassian.user.EntityException

findUsersAsList

List findUsersAsList(com.atlassian.user.search.query.Query finalQuery)
                     throws com.atlassian.user.EntityException

Find all users matching a particular query.

Throws:

com.atlassian.user.EntityException