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

java.lang.Object
  com.atlassian.jira.plugin.jql.function.AbstractJqlFunction
      com.atlassian.jira.plugin.jql.function.AbstractIssueTypeFunction
          com.atlassian.jira.plugin.jql.function.AllSubIssueTypesFunction

All Implemented Interfaces:

JqlFunction

public class AllSubIssueTypesFunction
extends AbstractIssueTypeFunction

Function that produces all the sub-task issue types.

Since:

v4.0

Field Summary

static String

FUNCTION_SUB_ISSUE_TYPES

Fields inherited from class com.atlassian.jira.plugin.jql.function.AbstractIssueTypeFunction

subTaskManager

Constructor Summary

AllSubIssueTypesFunction(ConstantsManager constantsManager, SubTaskManager subTaskManager)

Method Summary

List<QueryLiteral>	getValues(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause) Gets the unexpanded values provided by the user on input.
MessageSet	validate(com.atlassian.crowd.embedded.api.User user, 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.AbstractIssueTypeFunction

getDataType, getMinimumNumberOfExpectedArguments

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_SUB_ISSUE_TYPES

public static final String FUNCTION_SUB_ISSUE_TYPES

See Also:

Constant Field Values

Constructor Detail

AllSubIssueTypesFunction

public AllSubIssueTypesFunction(ConstantsManager constantsManager,
                                SubTaskManager subTaskManager)

Method Detail

getValues

public List<QueryLiteral> getValues(QueryCreationContext queryCreationContext,
                                    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:

queryCreationContext - the context of query creation

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. Cannot be null.

validate

public MessageSet validate(com.atlassian.crowd.embedded.api.User user,
                           FunctionOperand operand,
                           TerminalClause terminalClause)

Description copied from interface: JqlFunction

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

Specified by:

validate in interface JqlFunction

Overrides:

validate in class AbstractIssueTypeFunction

Parameters:

user - 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.