public class

DefaultSearchEntitiesManager

extends Object
implements SearchEntitiesManager
java.lang.Object
   ↳ com.atlassian.confluence.user.DefaultSearchEntitiesManager

Summary

[Expand]
Inherited Constants
From interface com.atlassian.confluence.user.SearchEntitiesManager
Public Constructors
DefaultSearchEntitiesManager()
Public Methods
Query createUserQuery(List queries, String operator)
List findGroupsAsList(TermQuery tQuery, boolean filterGroups)
Find the groups that match a particular query, optionally filtering out groups not visible to the current user.
List findGroupsAsList(TermQuery tQuery)
Find all groups matching a particular query.
List<User> findUsersAsList(Query userQuery)
Finds users according to the specified query.
TermQuery getGroupNameTermQuery(String groupnameTerm)
TermQuery getTermQuery(String term, Class termQueryClass)
Returns an instance of TermQuery based on the passed Class.
void setEntityQueryParser(EntityQueryParser entityQueryParser)
void setUserAccessor(UserAccessor userAccessor)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.confluence.user.SearchEntitiesManager

Public Constructors

public DefaultSearchEntitiesManager ()

Public Methods

public Query createUserQuery (List queries, String operator)

Throws
EntityQueryException

public List findGroupsAsList (TermQuery tQuery, boolean filterGroups)

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
EntityException

public List findGroupsAsList (TermQuery tQuery)

Find all groups matching a particular query.

Parameters
tQuery the query to search on
Throws
EntityException

public List<User> findUsersAsList (Query userQuery)

Finds users according to the specified query.

Parameters
userQuery the user query
Returns
  • a list of users. No two users with the same name (that is, getName() will be returned.
Throws
EntityException

public TermQuery getGroupNameTermQuery (String groupnameTerm)

Throws
EntityQueryException

public TermQuery getTermQuery (String term, Class termQueryClass)

Returns an instance of TermQuery based on the passed Class.

For example to retrieve a UserNameTermQuery you can call: getTermQuery(usernameTerm, UserNameTermQuery.class)
Parameters
term The search term
termQueryClass The class of the object that should be returned
Returns
  • An object which implements the TermQuery interface
Throws
EntityQueryException

public void setEntityQueryParser (EntityQueryParser entityQueryParser)

public void setUserAccessor (UserAccessor userAccessor)