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

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

All Implemented Interfaces:

JqlFunction

public class RemoteLinksByGlobalIdFunction
extends AbstractJqlFunction

Returns the issue ids of issues that are associated with remote links with any of the given global ids.

This function can only be used if Issue Linking is enabled.

Function usage: issuesWithRemoteLinksByGlobalId ( globalId [, globalId ]* )

The maximum number of global ids allowed by this function is 100.

Since:

v6.1

Field Summary

static String

FUNCTION_REMOTE_LINKS_BY_GLOBAL_ID

Constructor Summary

RemoteLinksByGlobalIdFunction(IssueLinkManager issueLinkManager, RemoteIssueLinkManager remoteIssueLinkManager)

Method Summary

JiraDataType	getDataType() Provides the JiraDataType that this function handles and creates values for.
int	getMinimumNumberOfExpectedArguments() expects at least one globalId as argument.
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 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_REMOTE_LINKS_BY_GLOBAL_ID

public static final String FUNCTION_REMOTE_LINKS_BY_GLOBAL_ID

See Also:

Constant Field Values

Constructor Detail

RemoteLinksByGlobalIdFunction

public RemoteLinksByGlobalIdFunction(IssueLinkManager issueLinkManager,
                                     RemoteIssueLinkManager remoteIssueLinkManager)

Method Detail

validate

@Nonnull
public MessageSet validate(com.atlassian.crowd.embedded.api.User searcher,
                                   @Nonnull
                                   FunctionOperand operand,
                                   @Nonnull
                                   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

@Nonnull
public List<QueryLiteral> getValues(@Nonnull
                                            QueryCreationContext queryCreationContext,
                                            @Nonnull
                                            FunctionOperand operand,
                                            @Nonnull
                                            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.

getMinimumNumberOfExpectedArguments

public int getMinimumNumberOfExpectedArguments()

expects at least one globalId as argument.

Returns:

the number of arguments that the function expects to perform its operation correctly. Must be >=0.

getDataType

@Nonnull
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