|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface JqlOperandResolver
Responsible for validating Operand
s and extracting the
QueryLiteral
values from them.
Method Summary | |
---|---|
QueryLiteral |
getSingleValue(com.atlassian.crowd.embedded.api.User user,
Operand operand,
TerminalClause clause)
Returns the single value contained within the passed operand. |
List<QueryLiteral> |
getValues(QueryCreationContext queryCreationContext,
Operand operand,
TerminalClause terminalClause)
Return the values contained within the passed operand. |
List<QueryLiteral> |
getValues(com.atlassian.crowd.embedded.api.User searcher,
Operand operand,
TerminalClause terminalClause)
Return the values contained within the passed operand. |
boolean |
isEmptyOperand(Operand operand)
Returns true if the operand represents an EMPTY operand. |
boolean |
isFunctionOperand(Operand operand)
Returns true if the passed operand is a function call. |
boolean |
isListOperand(Operand operand)
Returns true if the passed operand returns a list of values. |
boolean |
isValidOperand(Operand operand)
Returns true if the operand is one which is known about. |
FunctionOperand |
sanitiseFunctionOperand(com.atlassian.crowd.embedded.api.User searcher,
FunctionOperand operand)
Sanitise a function operand for the specified user, so that information is not leaked. |
MessageSet |
validate(com.atlassian.crowd.embedded.api.User user,
Operand operand,
TerminalClause terminalClause)
Validates the operand against its handler. |
MessageSet |
validate(com.atlassian.crowd.embedded.api.User searcher,
Operand operand,
WasClause clause)
|
Method Detail |
---|
MessageSet validate(com.atlassian.crowd.embedded.api.User searcher, Operand operand, WasClause clause)
List<QueryLiteral> getValues(com.atlassian.crowd.embedded.api.User searcher, Operand operand, TerminalClause terminalClause)
searcher
- the user performing the searchoperand
- the operand whose values should be returned. Must not be null.terminalClause
- the terminal clause that contained the operand
List<QueryLiteral> getValues(QueryCreationContext queryCreationContext, Operand operand, TerminalClause terminalClause)
queryCreationContext
- the context of query creationoperand
- the operand whose values should be returned. Must not be null.terminalClause
- the terminal clause that contained the operand
MessageSet validate(com.atlassian.crowd.embedded.api.User user, Operand operand, TerminalClause terminalClause)
user
- the user who is validating. May be null.operand
- the operand to be validated. Must not be null.terminalClause
- the terminal clause that contained the operand
MessageSet
containing any errors reported. Note: if the operand is
unknown, an error message will be added to the message set returned. Never null.FunctionOperand sanitiseFunctionOperand(com.atlassian.crowd.embedded.api.User searcher, FunctionOperand operand)
searcher
- the user performing the searchoperand
- the operand to sanitise; will only be sanitised if valid
QueryLiteral getSingleValue(com.atlassian.crowd.embedded.api.User user, Operand operand, TerminalClause clause)
user
- the user who is retrieving the values. May be null.operand
- the operand whose values should be returned. Must not be null.clause
- the terminal clause that contained the operand
IllegalArgumentException
- if the operand contains more than one value.boolean isEmptyOperand(Operand operand)
operand
- the operand to check if it is a EMPTY operand
boolean isFunctionOperand(Operand operand)
operand
- the operand to check. Cannot be null.
boolean isListOperand(Operand operand)
operand
- the operand to check. Cannot be null.
boolean isValidOperand(Operand operand)
SingleValueOperand
s
MultiValueOperand
s
EmptyOperand
s
FunctionOperand
s registered as JqlFunction
s
operand
- the operand; cannot be null.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |