com.atlassian.confluence.user
Interface SearchEntitiesManager

All Known Implementing Classes:
DefaultSearchEntitiesManager

public interface SearchEntitiesManager


Field Summary
static java.lang.String MATCH_ALL
           
static java.lang.String MATCH_ANY
           
 
Method Summary
 com.atlassian.user.search.query.Query createUserQuery(java.util.List queries, java.lang.String operator)
           
 java.util.List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery)
          Find all groups matching a particular query.
 java.util.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.
 java.util.List findUsersAsList(com.atlassian.user.search.query.Query finalQuery)
          Find all users matching a particular query.
 com.atlassian.user.search.query.TermQuery getGroupNameTermQuery(java.lang.String groupnameTerm)
           
 com.atlassian.user.search.query.TermQuery getTermQuery(java.lang.String term, java.lang.Class termQueryClass)
           
 

Field Detail

MATCH_ALL

static final java.lang.String MATCH_ALL
See Also:
Constant Field Values

MATCH_ANY

static final java.lang.String MATCH_ANY
See Also:
Constant Field Values
Method Detail

getTermQuery

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

getGroupNameTermQuery

com.atlassian.user.search.query.TermQuery getGroupNameTermQuery(java.lang.String groupnameTerm)
                                                                throws com.atlassian.user.search.query.EntityQueryException
Throws:
com.atlassian.user.search.query.EntityQueryException

createUserQuery

com.atlassian.user.search.query.Query createUserQuery(java.util.List queries,
                                                      java.lang.String operator)
                                                      throws com.atlassian.user.search.query.EntityQueryException
Throws:
com.atlassian.user.search.query.EntityQueryException

findGroupsAsList

java.util.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

java.util.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

java.util.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


Copyright © 2003-2014 Atlassian. All Rights Reserved.