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 Summary
 ClauseContextFactory getClauseContextFactory()
           
 ClauseQueryFactory getFactory()
           
 ClauseInformation getInformation()
           
 ClausePermissionHandler getPermissionHandler()
           
 ClauseValidator getValidator()
           
 

Method Detail

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

ClauseQueryFactory getFactory()
Returns:
a factory that can create a lucene query for the clause.

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


Copyright © 2002-2014 Atlassian. All Rights Reserved.