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 searchTerms, java.lang.String operator)
           
 com.atlassian.user.search.SearchResult findGroups(com.atlassian.user.search.query.TermQuery tQuery)
          Deprecated. since 2.8, use findGroupsAsList(com.atlassian.user.search.query.TermQuery) instead.
 com.atlassian.user.search.SearchResult findGroups(com.atlassian.user.search.query.TermQuery tQuery, boolean filterGroups)
          Deprecated. since 2.8, use findGroupsAsList(com.atlassian.user.search.query.TermQuery, boolean) instead.
 java.util.List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery)
          Equivalent to findGroups, however the results are immediately placed into a List.
 java.util.List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery, boolean filterGroups)
          Equivalent to findGroups(com.atlassian.user.search.query.TermQuery, boolean), but the results are immediately placed into a list.
 com.atlassian.user.search.SearchResult findUsers(com.atlassian.user.search.query.Query finalQuery)
          Deprecated. since 2.8, use findUsersAsList(com.atlassian.user.search.query.Query) instead.
 java.util.List findUsersAsList(com.atlassian.user.search.query.Query finalQuery)
          Equivalent to findUsers(com.atlassian.user.search.query.Query), but the results are immediately placed into a list.
 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

findGroups

com.atlassian.user.search.SearchResult findGroups(com.atlassian.user.search.query.TermQuery tQuery)
                                                  throws com.atlassian.user.EntityException
Deprecated. since 2.8, use findGroupsAsList(com.atlassian.user.search.query.TermQuery) instead.

Parameters:
tQuery -
Returns:
Throws:
com.atlassian.user.EntityException

findGroups

com.atlassian.user.search.SearchResult findGroups(com.atlassian.user.search.query.TermQuery tQuery,
                                                  boolean filterGroups)
                                                  throws com.atlassian.user.EntityException
Deprecated. since 2.8, use findGroupsAsList(com.atlassian.user.search.query.TermQuery, boolean) instead.

Parameters:
tQuery - The term query for the group search
filterGroups - Indicates whether the group search result should be filtered or not. If in doubt use findGroups(TermQuery tQuery, String repositoryKey) instead which will filter the groups based on whether sharedMode is enabled or not
Returns:
SearchResult
Throws:
com.atlassian.user.EntityException

findUsers

com.atlassian.user.search.SearchResult findUsers(com.atlassian.user.search.query.Query finalQuery)
                                                 throws com.atlassian.user.EntityException
Deprecated. since 2.8, use findUsersAsList(com.atlassian.user.search.query.Query) instead.

Parameters:
finalQuery -
Returns:
Throws:
com.atlassian.user.EntityException

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 searchTerms,
                                                      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
Equivalent to findGroups, however the results are immediately placed into a List.

Parameters:
tQuery -
Returns:
Throws:
com.atlassian.user.EntityException

findGroupsAsList

java.util.List findGroupsAsList(com.atlassian.user.search.query.TermQuery tQuery,
                                boolean filterGroups)
                                throws com.atlassian.user.EntityException
Equivalent to findGroups(com.atlassian.user.search.query.TermQuery, boolean), but the results are immediately placed into a list.

Throws:
com.atlassian.user.EntityException

findUsersAsList

java.util.List findUsersAsList(com.atlassian.user.search.query.Query finalQuery)
                               throws com.atlassian.user.EntityException
Equivalent to findUsers(com.atlassian.user.search.query.Query), but the results are immediately placed into a list.

Throws:
com.atlassian.user.EntityException


Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.