Class UserInfoQuery
- java.lang.Object
-
- com.atlassian.confluence.search.v2.query.UserInfoQuery
-
- All Implemented Interfaces:
Expandable<SearchQuery>
,SearchQuery
public class UserInfoQuery extends Object implements SearchQuery
SearchQuery for user info. It finds user(s) info based on the white-space delimited list of strings representing partial or full usernames or user full names. For example: given 2 users with username/full name: "gyellow"/"Yellow Gonzo" "gthing"/"Gonzo Thing" search for "go th" will return user info for "gthing" only whereas search for "gOn" will return user info for both users,- Since:
- 7.20
-
-
Field Summary
-
Fields inherited from interface com.atlassian.confluence.search.v2.SearchQuery
DEFAULT_BOOST
-
-
Constructor Summary
Constructors Constructor Description UserInfoQuery(String queryString)
Construct a SearchQuery that finds user(s) info by the prefix of the username or user full name
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SearchQuery
expand()
Expands this query into a composite query (that composes other queries).String
getKey()
List
getParameters()
List of parameters asString
s orSearchQuery
s.String
getQueryString()
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.atlassian.confluence.search.v2.SearchQuery
getBoost, getSubClauses
-
-
-
-
Constructor Detail
-
UserInfoQuery
public UserInfoQuery(String queryString)
Construct a SearchQuery that finds user(s) info by the prefix of the username or user full name- Parameters:
queryString
- white-space delimited list of strings representing partial or full usernames or user full names
-
-
Method Detail
-
getKey
public String getKey()
- Specified by:
getKey
in interfaceSearchQuery
- Returns:
- the plugin key
-
getParameters
public List getParameters()
Description copied from interface:SearchQuery
List of parameters asString
s orSearchQuery
s.- Specified by:
getParameters
in interfaceSearchQuery
- Returns:
String
s orSearchQuery
s.
-
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 interfaceExpandable<SearchQuery>
- Specified by:
expand
in interfaceSearchQuery
- Returns:
- a query
-
getQueryString
public String getQueryString()
-
-