public class

UserClauseValuesGenerator

extends Object
implements ClauseValuesGenerator
java.lang.Object
   ↳ com.atlassian.jira.jql.values.UserClauseValuesGenerator

Class Overview

Gets all the users for the specified value.

Summary

Public Constructors
UserClauseValuesGenerator(UserPickerSearchService userPickerSearchService)
Public Methods
ClauseValuesGenerator.Results getPossibleValues(User searcher, String jqlClauseName, String valuePrefix, int maxNumResults)
Will return a string representation of only the possible values that match the value prefix for this clause.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.atlassian.jira.jql.values.ClauseValuesGenerator

Public Constructors

public UserClauseValuesGenerator (UserPickerSearchService userPickerSearchService)

Public Methods

public ClauseValuesGenerator.Results getPossibleValues (User searcher, String jqlClauseName, String valuePrefix, int maxNumResults)

Will return a string representation of only the possible values that match the value prefix for this clause. This should not return more results than specified in maxNumResults. If it is possible this should use the maxNumResults to efficiently generate the results. The contract of this method is that if the valuePrefix exactly (minus case) matches the suggestion then we suggest it. This will allow users to verify in their own minds that even though they have typed the full value, it is still valid.

Parameters
searcher the user preforming the search.
jqlClauseName the jql clause name that was entered by the user, represents the identifier that was used to find this values generator. Note: for custom fields this can be used to identify the custom field we are dealing with.
valuePrefix the portion of the value that has already been provided by the user.
maxNumResults the maximun number of results to return.
Returns
  • a string value of the clause values that match the provided value prefix, empty list if none match.