com.atlassian.jira.plugin.jql.function
Class AbstractIssueTypeFunction
java.lang.Object
com.atlassian.jira.plugin.jql.function.AbstractJqlFunction
com.atlassian.jira.plugin.jql.function.AbstractIssueTypeFunction
- All Implemented Interfaces:
- JqlFunction
- Direct Known Subclasses:
- AllStandardIssueTypesFunction, AllSubIssueTypesFunction
public abstract class AbstractIssueTypeFunction
- extends AbstractJqlFunction
Base class for issue type functions.
- Since:
- v4.0
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
subTaskManager
protected final SubTaskManager subTaskManager
AbstractIssueTypeFunction
protected AbstractIssueTypeFunction(SubTaskManager subTaskManager)
validate
public MessageSet validate(com.atlassian.crowd.embedded.api.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 searchoperand
- the operand to validateterminalClause
- 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.
getMinimumNumberOfExpectedArguments
public int getMinimumNumberOfExpectedArguments()
- Description copied from interface:
JqlFunction
- This method must return the number of arguments that the function expects to perform its operation correctly. If
the function can accept a variable number of arguments this value should be the lower limit. It is perfectly
legal for a function to take no arguments and return 0 for this method.
- Returns:
- the number of arguments that the function expects to perform its operation correctly. Must be >=0.
getDataType
public JiraDataType getDataType()
- Description copied from interface:
JqlFunction
- Provides the
JiraDataType
that this function handles and creates values for. This
allows us to infer some information about how it will interact with other elements in the system.
For example, if this returns JiraDataTypes.DATE
then we know that we can provide
values for any clauses that also specify a data type of DATE.
- Returns:
- the JiraDataType that this function produces values for. Cannot be null.
- See Also:
JiraDataTypes
Copyright © 2002-2013 Atlassian. All Rights Reserved.