com.atlassian.confluence.user

Interface SearchEntitiesManager

All Known Implementing Classes:

DefaultSearchEntitiesManager

Deprecated.

since 5.9. Use CrowdService.search(com.atlassian.crowd.embedded.api.Query) instead.

@Deprecated
public interface SearchEntitiesManager

Field Summary

Fields

Modifier and Type	Field and Description
static String	MATCH_ALL Deprecated.
static String	MATCH_ANY Deprecated.

Method Summary

Modifier and Type	Method and Description
<T extends com.atlassian.user.Entity> com.atlassian.user.search.query.Query<T>	createUserQuery(List<? extends com.atlassian.user.search.query.Query<T>> queries, String operator) Deprecated.
List<com.atlassian.user.Group>	findGroupsAsList(com.atlassian.user.search.query.TermQuery<com.atlassian.user.Group> tQuery) Deprecated. Find all groups matching a particular query.
List<com.atlassian.user.Group>	findGroupsAsList(com.atlassian.user.search.query.TermQuery<com.atlassian.user.Group> tQuery, boolean filterGroups) Deprecated. Find the groups that match a particular query, optionally filtering out groups not visible to the current user.
List<com.atlassian.user.User>	findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> userQuery) Deprecated. Find all users matching a particular query.
List<com.atlassian.user.User>	findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> userQuery, boolean showUnlicensedUsers) Deprecated. Find all users matching a particular query.
com.atlassian.user.search.query.TermQuery<com.atlassian.user.Group>	getGroupNameTermQuery(String groupnameTerm) Deprecated.
<T extends com.atlassian.user.Entity> com.atlassian.user.search.query.TermQuery<T>	getTermQuery(String term, Class<? extends com.atlassian.user.search.query.TermQuery<T>> termQueryClass) Deprecated.

Field Detail

MATCH_ALL

static final String MATCH_ALL

Deprecated.

See Also:

Constant Field Values

MATCH_ANY

static final String MATCH_ANY

Deprecated.

See Also:

Constant Field Values

Method Detail

getTermQuery

<T extends com.atlassian.user.Entity> com.atlassian.user.search.query.TermQuery<T> getTermQuery(String term,
                                                                                                Class<? extends com.atlassian.user.search.query.TermQuery<T>> termQueryClass)
                                                                                         throws com.atlassian.user.search.query.EntityQueryException

Deprecated.

Throws:

com.atlassian.user.search.query.EntityQueryException

getGroupNameTermQuery

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

Deprecated.

Throws:

com.atlassian.user.search.query.EntityQueryException

createUserQuery

<T extends com.atlassian.user.Entity> com.atlassian.user.search.query.Query<T> createUserQuery(List<? extends com.atlassian.user.search.query.Query<T>> queries,
                                                                                               String operator)
                                                                                        throws com.atlassian.user.search.query.EntityQueryException

Deprecated.

Throws:

com.atlassian.user.search.query.EntityQueryException

findGroupsAsList

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

Deprecated.

Find all groups matching a particular query.

Parameters:

tQuery - the query to search on

Throws:

com.atlassian.user.EntityException

findGroupsAsList

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

Deprecated.

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<com.atlassian.user.User> findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> userQuery)
                                       throws com.atlassian.user.EntityException

Deprecated.

Find all users matching a particular query. By default, excludes unlicensed users from the results.

Parameters:

userQuery - the user query

Returns:

a list of users. No two users with the same name (that is, Entity.getName() will be returned.

Throws:

com.atlassian.user.EntityException

findUsersAsList

List<com.atlassian.user.User> findUsersAsList(com.atlassian.user.search.query.Query<com.atlassian.user.User> userQuery,
                                              boolean showUnlicensedUsers)
                                       throws com.atlassian.user.EntityException

Deprecated.

Find all users matching a particular query.

Parameters:

userQuery - the user query.

showUnlicensedUsers - whether to only include licensed users in the results.

Returns:

a list of users. No two users with the same name (that is, Entity.getName() will be returned.

Throws:

com.atlassian.user.EntityException