public class LinkedIssuesFunction extends AbstractJqlFunction implements ClauseSanitisingJqlFunction
This function can only be used if Issue Linking is enabled.
Function usage:
linkedIssues ( issuekey [, linkDescription ]* )
Modifier and Type | Field and Description |
---|---|
static String |
FUNCTION_LINKED_ISSUES |
Constructor and Description |
---|
LinkedIssuesFunction(JqlIssueSupport jqlIssueSupport,
IssueLinkTypeManager issueLinkTypeManager,
IssueLinkManager issueLinkManager,
PermissionManager permissionManager) |
Modifier and Type | Method and Description |
---|---|
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)
Gets the unexpanded values provided by the user on input.
|
FunctionOperand |
sanitiseOperand(ApplicationUser searcher,
FunctionOperand operand)
Sanitise a function operand for the specified user, so that information is not leaked.
|
MessageSet |
validate(ApplicationUser searcher,
FunctionOperand operand,
TerminalClause terminalClause)
Will validate the function operand's arguments and report back any errors.
|
getFunctionName, getI18n, getModuleDescriptor, init, isList, validateNumberOfArgs
public static final String FUNCTION_LINKED_ISSUES
public LinkedIssuesFunction(JqlIssueSupport jqlIssueSupport, IssueLinkTypeManager issueLinkTypeManager, IssueLinkManager issueLinkManager, PermissionManager permissionManager)
public MessageSet validate(ApplicationUser 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 operandpublic List<QueryLiteral> getValues(QueryCreationContext queryCreationContext, FunctionOperand operand, TerminalClause terminalClause)
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 QueryLiteral
s 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.
getValues
in interface JqlFunction
queryCreationContext
- the context of query creationoperand
- the operand to get values fromterminalClause
- the terminal clause that contains the operandpublic 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
public FunctionOperand sanitiseOperand(ApplicationUser searcher, FunctionOperand operand)
ClauseSanitisingJqlFunction
sanitiseOperand
in interface ClauseSanitisingJqlFunction
searcher
- the user performing the searchoperand
- the operand to sanitise; will only be sanitised if validCopyright © 2002-2021 Atlassian. All Rights Reserved.