Package com.atlassian.jira.plugin.jql.function

Class UpdatedByFunction

java.lang.Object

com.atlassian.jira.plugin.jql.function.AbstractJqlFunction

com.atlassian.jira.plugin.jql.function.UpdatedByFunction

All Implemented Interfaces:

JqlFunction

public class UpdatedByFunction
extends AbstractJqlFunction

Returns the issue ids of issues updated by specific user, within optional time frame (from, or from - to given date(s))

Function usage:

id in updatedBy("username") or

id in updatedBy("username",JQL_FROM_DATE) or

id in updatedBy("username",JQL_FROM_DATE,JQL_TO_DATE)

Since:

v8.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FUNCTION_ISSUES_UPDATED
static final String	PROFILING_ID

Constructor Summary

Constructors

Constructor	Description
UpdatedByFunction(UserResolver userResolver, UpdateHistoryAccessor updateHistoryAccessor, JqlDateSupport jqlDateSupport, com.atlassian.event.api.EventPublisher eventPublisher)

Method Summary

Modifier and Type	Method	Description
JiraDataType	getDataType()	Provides the JiraDataType that this function handles and creates values for.
String	getFunctionName()	The name of the function.
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.
MessageSet	validate(ApplicationUser searcher, FunctionOperand operand, TerminalClause terminalClause)	Will validate the function operand's arguments and report back any errors.
protected boolean	validateDate(MessageSet messageSet, String dateString, String i18nKey)

Methods inherited from class com.atlassian.jira.plugin.jql.function.AbstractJqlFunction

getI18n, getModuleDescriptor, init, isList, validateNumberOfArgs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FUNCTION_ISSUES_UPDATED

public static final String FUNCTION_ISSUES_UPDATED

See Also:

• Constant Field Values

PROFILING_ID

public static final String PROFILING_ID

See Also:

• Constant Field Values

Constructor Details

UpdatedByFunction

public UpdatedByFunction(UserResolver userResolver,
 UpdateHistoryAccessor updateHistoryAccessor,
 JqlDateSupport jqlDateSupport,
 com.atlassian.event.api.EventPublisher eventPublisher)

Method Details

validate

@Nonnull
public MessageSet validate(ApplicationUser 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 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.

validateDate

protected boolean validateDate(MessageSet messageSet,
 String dateString,
 String i18nKey)

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()

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

getFunctionName

public String getFunctionName()

Description copied from interface: JqlFunction

The name of the function. Multiple calls to this method must return the same result. This means that the function name cannot be internationalised with respect to the searcher.

Specified by:

getFunctionName in interface JqlFunction

Overrides:

getFunctionName in class AbstractJqlFunction

Returns:

the name of the function. Cannot be null.