|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.atlassian.jira.plugin.jql.function.AbstractJqlFunction
com.atlassian.jira.plugin.jql.function.AbstractUserBasedFunction
public abstract class AbstractUserBasedFunction
This is an abstract parent to user based functions that rely on returning a list of a list of QueryLiteral based on either the current user or a user passed as a parameter.
This function expects zero or one argument. If zero arguments are supplied the current logged in user will be used.
Field Summary | |
---|---|
protected UserUtil |
userUtil
|
Constructor Summary | |
---|---|
AbstractUserBasedFunction(UserUtil userUtil)
|
Method Summary | |
---|---|
protected abstract List<QueryLiteral> |
getFunctionValuesList(QueryCreationContext queryCreationContext,
FunctionOperand operand,
com.atlassian.crowd.embedded.api.User user)
Get the function return values based on the actual user. |
int |
getMinimumNumberOfExpectedArguments()
This method must return the number of arguments that the function expects to perform its operation correctly. |
protected abstract String |
getUserNotFoundMessageKey()
Get the I18n message key for the error when the passed in user does not exist. |
List<QueryLiteral> |
getValues(QueryCreationContext queryCreationContext,
FunctionOperand functionOperand,
TerminalClause terminalClause)
Gets the unexpanded values provided by the user on input. |
MessageSet |
validate(com.atlassian.crowd.embedded.api.User searcher,
FunctionOperand functionOperand,
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 |
---|
getDataType |
Field Detail |
---|
protected final UserUtil userUtil
Constructor Detail |
---|
public AbstractUserBasedFunction(UserUtil userUtil)
Method Detail |
---|
public MessageSet validate(com.atlassian.crowd.embedded.api.User searcher, FunctionOperand functionOperand, TerminalClause terminalClause)
JqlFunction
searcher
- the user performing the searchfunctionOperand
- the operand to validateterminalClause
- the terminal clause that contains the operand
public int getMinimumNumberOfExpectedArguments()
JqlFunction
public List<QueryLiteral> getValues(QueryCreationContext queryCreationContext, FunctionOperand functionOperand, 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.
queryCreationContext
- the context of query creationfunctionOperand
- the operand to get values fromterminalClause
- the terminal clause that contains the operand
protected abstract List<QueryLiteral> getFunctionValuesList(QueryCreationContext queryCreationContext, FunctionOperand operand, com.atlassian.crowd.embedded.api.User user)
queryCreationContext
- the context of query creationoperand
- the operand to get values fromuser
- the user
protected abstract String getUserNotFoundMessageKey()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |