Package com.atlassian.confluence.search.v2.query

Class ContributorQuery

java.lang.Object

com.atlassian.confluence.search.v2.query.AbstractUserQuery

com.atlassian.confluence.search.v2.query.ContributorQuery

All Implemented Interfaces:

Expandable<SearchQuery>, SearchQuery

public class ContributorQuery
extends AbstractUserQuery
implements SearchQuery

Creates a query to find content a user has contributed to (any edit or create is considered a contribution)

Nested Class Summary

Nested classes/interfaces inherited from class com.atlassian.confluence.search.v2.query.AbstractUserQuery

AbstractUserQuery.Parameter

Field Summary

Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery

DEFAULT_BOOST

Constructor Summary

Constructors

Constructor	Description
ContributorQuery(@NonNull com.atlassian.sal.api.user.UserKey userKey, ConfluenceUserDao confluenceUserDao)
ContributorQuery(String username, ConfluenceUserDao confluenceUserDao)
ContributorQuery(List<AbstractUserQuery.Parameter> params, ConfluenceUserDao confluenceUserDao)	Create a query that matches content that has been contributed to by any of the users described by the provided list of parameters.

Method Summary

Modifier and Type	Method	Description
SearchQuery	expand()	Expands this query into a composite query (that composes other queries).
String	getKey()

Methods inherited from class com.atlassian.confluence.search.v2.query.AbstractUserQuery

equals, getParameters, hashCode, userkey, username

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery

getBoost, getParameters, getSubClauses

Constructor Details

ContributorQuery

public ContributorQuery(String username,
 ConfluenceUserDao confluenceUserDao)

ContributorQuery

public ContributorQuery(@NonNull com.atlassian.sal.api.user.UserKey userKey,
 ConfluenceUserDao confluenceUserDao)

ContributorQuery

public ContributorQuery(List<AbstractUserQuery.Parameter> params,
 ConfluenceUserDao confluenceUserDao)

Create a query that matches content that has been contributed to by any of the users described by the provided list of parameters.

Parameters:

params - list of parameters to match users with

confluenceUserDao -

Since:

8.8

Method Details

getKey

public String getKey()

Specified by:

getKey in interface SearchQuery

Returns:

the plugin key

expand

public SearchQuery expand()

Description copied from interface: SearchQuery

Expands this query into a composite query (that composes other queries). By overriding this method, one can specify a new query that is composition of the behaviour of the composed queries.

Specified by:

expand in interface Expandable<SearchQuery>

Specified by:

expand in interface SearchQuery

Returns:

a query