|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.plugin.jql.function.AbstractJqlFunction com.atlassian.jira.plugin.jql.function.CascadeOptionFunction
public class CascadeOptionFunction
A function that allows the user to select children of a specific parent option for cascading select fields.
Unlike most functions, this function requires knowledge of the field it was used with, so that it can figure out which options are valid for it to generate.
The function accepts either 1 or 2 arguments:
Field Summary | |
---|---|
static String |
EMPTY_VALUE
|
static String |
FUNCTION_CASCADE_OPTION
For building clauses containing this function |
static String |
QUOTED_EMPTY_VALUE
|
Constructor Summary | |
---|---|
CascadeOptionFunction(JqlSelectOptionsUtil jqlSelectOptionsUtil,
SearchHandlerManager searchHandlerManager,
CustomFieldManager customFieldManager,
JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil)
|
Method Summary | |
---|---|
JiraDataType |
getDataType()
Provides the JiraDataType that this function handles and creates values for. |
int |
getMinimumNumberOfExpectedArguments()
This method must return the number of arguments that the function expects to perform its operation correctly. |
List<QueryLiteral> |
getValues(QueryCreationContext queryCreationContext,
FunctionOperand operand,
TerminalClause terminalClause)
Note: this method returns unconvential query literals. |
MessageSet |
validate(com.atlassian.crowd.embedded.api.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 |
Methods inherited from interface com.atlassian.jira.plugin.jql.function.JqlFunction |
---|
getFunctionName, init, isList |
Field Detail |
---|
public static final String FUNCTION_CASCADE_OPTION
public static final String EMPTY_VALUE
public static final String QUOTED_EMPTY_VALUE
Constructor Detail |
---|
public CascadeOptionFunction(JqlSelectOptionsUtil jqlSelectOptionsUtil, SearchHandlerManager searchHandlerManager, CustomFieldManager customFieldManager, JqlCascadingSelectLiteralUtil jqlCascadingSelectLiteralUtil)
Method Detail |
---|
public MessageSet validate(com.atlassian.crowd.embedded.api.User searcher, FunctionOperand operand, TerminalClause terminalClause)
JqlFunction
validate
in interface JqlFunction
searcher
- the user performing the searchoperand
- the operand to validateterminalClause
- the terminal clause that contains the operand
public List<QueryLiteral> getValues(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause)
QueryLiteral
s
returned will have Long values, but they may be either positive or negative. Positive values indicate that the
option ids should be included in the results, whereas negative ids mean that they should be excluded.
getValues
in interface JqlFunction
queryCreationContext
- the context of query creationoperand
- the operand to get values fromterminalClause
- the terminal clause that contains the operand
public int getMinimumNumberOfExpectedArguments()
JqlFunction
getMinimumNumberOfExpectedArguments
in interface JqlFunction
public JiraDataType getDataType()
JqlFunction
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.
getDataType
in interface JqlFunction
JiraDataTypes
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |