Package com.atlassian.jira.jql

Interface ClauseHandler

All Known Implementing Classes:
DefaultClauseHandler, DefaultValuesGeneratingClauseHandler, NoOpClauseHandler
@PublicApi public interface ClauseHandler
A container for all the objects needed to process a Jql clause.
Since:
v4.0

  • Method Details

    • getInformation

      ClauseInformation getInformation()
      Returns:
      an object that contains some static naming information (clause names, field id, index id) about the clause handler and its associations.

    • getFactory

      @Deprecated(since="10.4", forRemoval=true) ClauseQueryFactory getFactory()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use getMapper() instead.
      Returns:
      a mapper that can create a search query for the clause.

    • getMapper

      default ClauseQueryMapper getMapper()
      Get a mapper that can create a search query for the clause. To replace the deprecated getFactory() method.
      Returns:

    • getValidator

      ClauseValidator getValidator()
      Returns:
      a validator that will inspect the clause and return any validation errors it encounters.

    • getPermissionHandler

      ClausePermissionHandler getPermissionHandler()
      Returns:
      a permission handler that will check the users who is executing the queries permission to include the clause.

    • getClauseContextFactory

      ClauseContextFactory getClauseContextFactory()
      Returns:
      a clause context factory that will be able to generate the clause context