com.atlassian.jira.issue.search.searchers.util
Interface QuerySearcherInputHelper

All Known Implementing Classes:
DefaultQuerySearcherInputHelper

public interface QuerySearcherInputHelper

Interface for parsing JQL clauses to determine if they are suitable for usage in the Navigator or Search URL.

Since:
v4.0

Method Summary
 java.util.Map<java.lang.String,java.lang.String> convertClause(Clause clause, com.opensymphony.user.User user)
          Take the passed clause and try and get the equivalent navigator parameters.
 

Method Detail

convertClause

java.util.Map<java.lang.String,java.lang.String> convertClause(Clause clause,
                                                               com.opensymphony.user.User user)
Take the passed clause and try and get the equivalent navigator parameters. Note: this also performs a validity check on the structure of the clause to determine if it fits for the Navigator. Therefore, it is not required to check this before the call is made.

Parameters:
clause - the clause to convert.
user - the user trying to convert the clause.
Returns:
on success a map of navigator param -> value, or null on failure. The map will only contain the params that were present in the clause.


Copyright © 2002-2010 Atlassian. All Rights Reserved.