com.atlassian.jira.plugin.jql.function
Class VotedIssuesFunction

java.lang.Object
  com.atlassian.jira.plugin.jql.function.AbstractJqlFunction
      com.atlassian.jira.plugin.jql.function.VotedIssuesFunction

All Implemented Interfaces:

JqlFunction

public class VotedIssuesFunction
extends AbstractJqlFunction

Returns the issue ids of the voted issues for the current user. This function can only be used if Voting on Issues is currently enabled.

Since:

v4.0

Field Summary

static String

FUNCTION_VOTED_ISSUES

Constructor Summary

VotedIssuesFunction(IssueManager issueManager, ApplicationProperties applicationProperties)

Method Summary

List<QueryLiteral>	getValues(User searcher, FunctionOperand operand, TerminalClause terminalClause) Gets the unexpanded values provided by the user on input.
MessageSet	validate(User searcher, FunctionOperand operand, TerminalClause terminalClause) Will validate the function operand's arguments and report back any errors.

Methods inherited from class com.atlassian.jira.plugin.jql.function.AbstractJqlFunction

getFunctionName, getI18n, getModuleDescriptor, init, isList, validateNumberOfArgs

Methods inherited from class java.lang.Object

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

Field Detail

FUNCTION_VOTED_ISSUES

public static final String FUNCTION_VOTED_ISSUES

See Also:

Constant Field Values

Constructor Detail

VotedIssuesFunction

public VotedIssuesFunction(IssueManager issueManager,
                           ApplicationProperties applicationProperties)

Method Detail

validate

public MessageSet validate(User searcher,
                           FunctionOperand operand,
                           TerminalClause terminalClause)

Description copied from interface: JqlFunction

Will validate the function operand's arguments and report back any errors.

Parameters:

searcher - the user performing the search

operand - the operand to validate

terminalClause - the terminal clause that contains the operand

Returns:

a MessageSet which will contain any validation errors or warnings or will be empty if there is nothing to report; never null.

getValues

public List<QueryLiteral> getValues(User searcher,
                                    FunctionOperand operand,
                                    TerminalClause terminalClause)

Description copied from interface: JqlFunction

Gets the unexpanded values provided by the user on input. This is the output values that will later be transformed into index values.

For example, a function who returns all the released versions of a specified project should return QueryLiterals representing the ids of those versions. For correctness, always opt to return the most specific identifier for the object; if you can return either the id (which is stored in the index) or a string name (that would require resolving to get the index value), choose the id.

Parameters:

searcher - the user performing the search

operand - the operand to get values from

terminalClause - the terminal clause that contains the operand

Returns:

a List of objects that represent this Operands raw values.