com.atlassian.confluence.user
Class DefaultSearchEntitiesManager

java.lang.Object
  com.atlassian.confluence.user.DefaultSearchEntitiesManager

All Implemented Interfaces:

SearchEntitiesManager

public class DefaultSearchEntitiesManager
extends java.lang.Object
implements SearchEntitiesManager

Field Summary

Fields inherited from interface com.atlassian.confluence.user.SearchEntitiesManager

MATCH_ALL, MATCH_ANY

Constructor Summary

DefaultSearchEntitiesManager()

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 SearchEntitiesManager.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 query) 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 SearchEntitiesManager.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) Returns an instance of TermQuery based on the passed Class.
void	setEntityQueryParser(com.atlassian.user.search.query.EntityQueryParser entityQueryParser)
void	setUserAccessor(UserAccessor userAccessor)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSearchEntitiesManager

public DefaultSearchEntitiesManager()

Method Detail

findGroups

public 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

Specified by:

findGroups in interface SearchEntitiesManager

Parameters:

tQuery -

Returns:

Throws:

com.atlassian.user.EntityException

findGroups

public 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

Specified by:

findGroups in interface SearchEntitiesManager

Parameters:

tQuery -

filterGroups -

Returns:

Throws:

com.atlassian.user.EntityException

findUsers

public com.atlassian.user.search.SearchResult findUsers(com.atlassian.user.search.query.Query query)
                                                 throws com.atlassian.user.EntityException

Deprecated. since 2.8, use findUsersAsList(com.atlassian.user.search.query.Query) instead.

Specified by:

findUsers in interface SearchEntitiesManager

Parameters:

query -

Returns:

Throws:

com.atlassian.user.EntityException

findGroupsAsList

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

Description copied from interface: SearchEntitiesManager

Equivalent to findGroups, however the results are immediately placed into a List.

Specified by:

findGroupsAsList in interface SearchEntitiesManager

Returns:

Throws:

com.atlassian.user.EntityException

findGroupsAsList

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

Description copied from interface: SearchEntitiesManager

Equivalent to SearchEntitiesManager.findGroups(com.atlassian.user.search.query.TermQuery, boolean), but the results are immediately placed into a list.

Specified by:

findGroupsAsList in interface SearchEntitiesManager

Throws:

com.atlassian.user.EntityException

findUsersAsList

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

Description copied from interface: SearchEntitiesManager

Equivalent to SearchEntitiesManager.findUsers(com.atlassian.user.search.query.Query), but the results are immediately placed into a list.

Specified by:

findUsersAsList in interface SearchEntitiesManager

Throws:

com.atlassian.user.EntityException

getTermQuery

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

Returns an instance of TermQuery based on the passed Class.

For example to retrieve a UserNameTermQuery you can call: getTermQuery(usernameTerm, UserNameTermQuery.class)

Specified by:

getTermQuery in interface SearchEntitiesManager

Parameters:

term - The search term

termQueryClass - The class of the object that should be returned

Returns:

An object which implements the TermQuery interface

Throws:

com.atlassian.user.search.query.EntityQueryException

getGroupNameTermQuery

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

Specified by:

getGroupNameTermQuery in interface SearchEntitiesManager

Throws:

com.atlassian.user.search.query.EntityQueryException

createUserQuery

public com.atlassian.user.search.query.Query createUserQuery(java.util.List searchTerms,
                                                             java.lang.String operator)
                                                      throws com.atlassian.user.search.query.EntityQueryException

Specified by:

createUserQuery in interface SearchEntitiesManager

Throws:

com.atlassian.user.search.query.EntityQueryException

setEntityQueryParser

public void setEntityQueryParser(com.atlassian.user.search.query.EntityQueryParser entityQueryParser)

setUserAccessor

public void setUserAccessor(UserAccessor userAccessor)