com.atlassian.jira.jql.validator
Interface OperatorUsageValidator

All Known Implementing Classes:
DefaultOperatorUsageValidator

public interface OperatorUsageValidator

Performs global validation about where it is appropriate to use an Operator. This does checks to see that list operators are not used with non-lists and vice-versa.

Since:
v4.0

Method Summary
 boolean check(User searcher, TerminalClause clause)
          Check the usage of the Operator and Operand that are held in the clause.
 MessageSet validate(User searcher, TerminalClause clause)
          Validate the usage of the Operator and Operand that are held in the clause.
 

Method Detail

validate

MessageSet validate(User searcher,
                    TerminalClause clause)
Validate the usage of the Operator and Operand that are held in the clause. The clause specific validation, as to whether the clause has any specific issues with the configuration occurs elsewhere. This is just performing global Operator/Operand checks.

Parameters:
searcher - the user performing the validation, used to get i18n information.
clause - the clause that contains the Operator and Operand.
Returns:
a MessageSet that will contain any errors or warnings that may have been generated from the validation.

check

boolean check(User searcher,
              TerminalClause clause)
Check the usage of the Operator and Operand that are held in the clause. The clause specific validation, as to whether the clause has any specific issues with the configuration occurs elsewhere. This is just performing global Operator/Operand checks.

Parameters:
searcher - the user performing the validation, used to get i18n information.
clause - the clause that contains the Operator and Operand.
Returns:
true if the passed clause is valid, false otherwise.


Copyright © 2002-2009 Atlassian. All Rights Reserved.