com.atlassian.jira.plugin.jql.function

Class ProjectsLeadByUserFunction

java.lang.Object

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

com.atlassian.jira.plugin.jql.function.AbstractUserBasedFunction

com.atlassian.jira.plugin.jql.function.ProjectsLeadByUserFunction

All Implemented Interfaces:

JqlFunction

public class ProjectsLeadByUserFunction
extends AbstractUserBasedFunction

This function returns a list of projects lead by a user.

This function expects zero or one argument. If zero arguments are supplied the current logged in user will be used as project lead.

Since:

v4.2

Field Summary

Fields

Modifier and Type	Field and Description
static String	FUNCTION_PROJECTS_LEAD_BY_USER

Fields inherited from class com.atlassian.jira.plugin.jql.function.AbstractUserBasedFunction

globalPermissionManager, userUtil

Constructor Summary

Constructors

Constructor and Description
ProjectsLeadByUserFunction(PermissionManager permissionManager, ProjectManager projectManager, UserUtil userUtil, GlobalPermissionManager globalPermissionManager)

Method Summary

Modifier and Type	Method and Description
JiraDataType	getDataType() Provides the JiraDataType that this function handles and creates values for.
protected List<QueryLiteral>	getFunctionValuesList(QueryCreationContext queryCreationContext, FunctionOperand functionOperand, ApplicationUser user) Get the function return values based on the actual user.
protected String	getUserNotFoundMessageKey() Get the I18n message key for the error when the passed in user does not exist.

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

getMessageForDisallowedAnonymousAccess, getMinimumNumberOfExpectedArguments, getValues, isAnonymousAccessAllowed, validate, validateQuery

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_PROJECTS_LEAD_BY_USER

public static final String FUNCTION_PROJECTS_LEAD_BY_USER

See Also:

Constant Field Values

Constructor Detail

ProjectsLeadByUserFunction

public ProjectsLeadByUserFunction(PermissionManager permissionManager,
                                  ProjectManager projectManager,
                                  UserUtil userUtil,
                                  GlobalPermissionManager globalPermissionManager)

Method Detail

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

getFunctionValuesList

protected List<QueryLiteral> getFunctionValuesList(QueryCreationContext queryCreationContext,
                                                   FunctionOperand functionOperand,
                                                   ApplicationUser user)

Description copied from class: AbstractUserBasedFunction

Get the function return values based on the actual user. transformed into index values.

Specified by:

getFunctionValuesList in class AbstractUserBasedFunction

Parameters:

queryCreationContext - the context of query creation

functionOperand - the operand to get values from

user - the user

Returns:

a List of objects that represent this Operands raw values. Cannot be null.

getUserNotFoundMessageKey

protected String getUserNotFoundMessageKey()

Description copied from class: AbstractUserBasedFunction

Get the I18n message key for the error when the passed in user does not exist.

Specified by:

getUserNotFoundMessageKey in class AbstractUserBasedFunction

Returns:

message key.